Update README.md (#85)

* Update README.md Added documentation regarding password for cast-sh. * Apply suggestions from code review better usage documentation Co-Authored-By: Charles Reid <[email protected]>
0xHericles · Dec 6, 2019 · 11c4e7c · 11c4e7c
1 parent 986f648
commit 11c4e7c
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,8 @@ To start the terminal cast application, run:
 ```
 python3 -m cast
 ```
+
+
 #### Arguments
 ```
 optional arguments:
@@ -45,7 +47,19 @@ optional arguments:
   --command COMMAND         Command to run in the terminal (default: bash)
   --cmd-args CMD_ARGS       arguments to pass to command (i.e. --cmd-args='arg1
                             arg2 --flag') (default: )
+  --password PASSWORD       set a password for accessing cast-sh
+                            sessions (default: admin)
+```
+#### A password can be set using an environment variable as well.
+Unix
+```
+export PASSWORD="weakpassword"
 ```
+Windows
+```
+set PASSWORD="weakpassword"
+```
+
 #### Docker
 Build image
 ```