simono41/steamguard-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update README.md with new help text

Browse source
This commit is contained in:
Carson McManus 2017-05-22 18:26:54 -04:00
parent f68b617e7c
commit 8be48008c2
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -42,9 +42,9 @@ To install after building from source, run:
sudo make install sudo make install
# Usage # Usage
`steamguard-cli` looks for your `maFiles` folder in the current user's home directory (eg. `~/maFiles/`). `steamguard-cli` looks for your `maFiles` folder in the current user's home directory (eg. `~/maFiles/`).
Your `maFiles` can be created with [Steam Desktop Authenticator][SDA]. You can create `maFiles` with Your `maFiles` can be created with [Steam Desktop Authenticator][SDA]. You can create `maFiles` with
steamguard-cli using the `setup` action (`steamguard setup`). steamguard-cli using the `setup` action (`steamguard setup`).
**REMEMBER TO MAKE BACKUPS OF YOUR `maFiles`, AND TO WRITE DOWN YOUR RECOVERY CODE!** **REMEMBER TO MAKE BACKUPS OF YOUR `maFiles`, AND TO WRITE DOWN YOUR RECOVERY CODE!**
@ -56,6 +56,7 @@ steamguard-cli using the `setup` action (`steamguard setup`).
-h, --help Display this help message. -h, --help Display this help message.
-v, --verbose Display some extra information when the program is running. -v, --verbose Display some extra information when the program is running.
-m, --mafiles-path Specify which folder your maFiles are in. Ex: ~/maFiles -m, --mafiles-path Specify which folder your maFiles are in. Ex: ~/maFiles
-p, --passkey Specify your encryption passkey.
Actions: Actions:
generate-code Generate a Steam Guard code for the specified user (if any) and exit. (default) generate-code Generate a Steam Guard code for the specified user (if any) and exit. (default)
@ -65,3 +66,5 @@ steamguard-cli using the `setup` action (`steamguard setup`).
2fa Same as generate-code 2fa Same as generate-code
add Set up Steam Guard for 2 factor authentication. add Set up Steam Guard for 2 factor authentication.
setup Same as add setup Same as add
trade Opens an interactive prompt to handle trade confirmations.
accept-all Accepts all trade confirmations.