update readme to check push main branch

README.md

@@ -6,6 +6,15 @@ buddy is a work in progress, if you are intrerested in using it in your workflow
 
 It's important to reduce cognitive overload for the researcher, as measured in seconds-to-first-tensorboard-datapoint.
 
+Table of contents
+=================
+
+<!--ts-->
+
+* [Quick start with Buddy cli](#quick-start-with-buddy-cli)
+  * [Requirements](#requirements)
+  * [Installation](#installation)
+
 Right now its responsibilities cover:
 1. Deployment on servers
 1. Handling of Sweeps
@@ -16,9 +25,11 @@ Right now its responsibilities cover:
 
 Example: (Updated)
 
-# Quick start with Buddy cli
+Quick start with Buddy cli
+==========================
 
-## Requirements
+Requirements
+------------
 
 1. You now need to setup the cluster SSH key. how create and add your SSH keys can be found [here](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account) 
 1. Add cluster public-key to: `https://github.com/settings/keys` if you don't know this yet, check this out [here](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)
@@ -27,7 +38,9 @@ Example: (Updated)
     - or set export  WANDB_API_KEY = your wandb key which can be found here: https://wandb.ai/settings
 
 
-## Installation
+Installation
+------------
+
 ### Directly from pip
 ```shell
 pip install experiment-buddy