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

updated README.md

Browse source
This commit is contained in:
Carson McManus 2016-08-23 19:56:39 -04:00
parent cf7e858b88
commit 6c2acad02f
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -29,7 +29,11 @@ To run the current build:
Coming soon... Coming soon...
# Installation # Installation
Coming soon... Packages are coming soon...
To install after building from source, run:
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/`).
@ -41,10 +45,10 @@ steamguard-cli is not supported at this time.
[SDA]: https://github.com/Jessecar96/SteamDesktopAuthenticator [SDA]: https://github.com/Jessecar96/SteamDesktopAuthenticator
## Arguments ## Arguments
--help, -h Display this help message. --help, -h Display this help message.
--verbose, -v Display some extra information when the program is running. --verbose, -v Display some extra information when the program is running.
--user, -u Specify an account for which to generate a Steam Gaurd code. --user, -u Specify an account for which to generate a Steam Gaurd code.
Otherwise, the first account will be selected. Otherwise, the first account will be selected.
--generate-code Generate a Steam Guard code and exit. (default) --generate-code Generate a Steam Guard code and exit. (default)
--encrypt Encrypt your maFiles or change your encryption passkey. --encrypt Encrypt your maFiles or change your encryption passkey.
--decrypt Remove encryption from your maFiles. --decrypt Remove encryption from your maFiles.