summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
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