readme: add initial login instruction

Signed-off-by: Vallari Agrawal <[email protected]>
VallariAg · Mar 13, 2023 · ae5ed4b · ae5ed4b
1 parent 81229a9
commit ae5ed4b
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -27,12 +27,14 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
 
 The documentation can be accessed at http://localhost:8082/docs after running the application.
 
+Note: To run commands, authenticate by visiting `http://localhost:8082/login` through browser and follow the github authentication steps (this stores the auth token in browser cookies). 
+
 ### Route `/`
 
 ```
 curl http://localhost:8082/
 ```
-Returns `{"root": "success"}`.
+Returns `{"root": "success", "session": { <authentication details> }}`.
 
 ### Route `/suite`