diff options
| author | Michaël Ball <michael.ball@gmail.com> | 2018-11-18 12:16:55 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-18 12:16:55 +0000 |
| commit | c7e59c4143077b9e15e3d6dc3fe1a3523cd0eebb (patch) | |
| tree | 973d03cba05a84b591ca050a4ff65556ea9f0823 | |
| parent | 40df2f617ef9a29c89ebadb571f39f230be23581 (diff) | |
Create README.md
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5bf31bd --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# rust-passphrasegen +A passphrase generator written in Rust. + +## Usage +Build by running `cargo build --release`. + +Generate a passphrase by running `passphrasegen`. + +Required arguments: +* Path to words file (eg. /usr/share/dict/words) + +### Example + +Generate a passphrase of 5 words using the american english wordlist: + + $ passphrasegen -w 5 /usr/share/dict/american-english |