Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
neydroid committed Jun 14, 2016
1 parent 20d25ef commit 8240aca
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ A command line password generator implemented in Rust

`cargo build --release && ./target/release/sphinx-passwords`

### Usage Options

- Use `-l` or `--length` with a number to set the length of password for example: `-l 34` returns 34 characters. This option defaults to a random length between 10 and 20 if is not passed.
- Use `-s` to mute all messages, only returns the password. This is useful to use the binary in a script or an automation tool

## Tests

Tests are in tests folder, to run tests use `cargo test`
Expand Down

0 comments on commit 8240aca

Please sign in to comment.