From c7e59c4143077b9e15e3d6dc3fe1a3523cd0eebb Mon Sep 17 00:00:00 2001 From: Michaël Ball Date: Sun, 18 Nov 2018 12:16:55 +0000 Subject: Create README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md 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 -- cgit v1.2.3