summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichaël Ball <michael.ball@gmail.com>2016-09-04 22:50:17 +0100
committerGitHub <noreply@github.com>2016-09-04 22:50:17 +0100
commit181f76b7ffec963573e9997675e8207f0fb48661 (patch)
treedae621b162425574e4b8a0e54ea9d99de48e44de
parent21eb15e87b42728d6fd3de6cbc256dde62fbacfd (diff)
Update with usage instructions
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1486934..a1815a9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
# passphrasegen
A passphrase generator written in Go
+
+## Usage
+Install with by running `go install`, or build and run by running `go build`.
+
+Generate a passphrase by running `passphrasegen`.
+
+Optional arguments:
+* -w number: number of words to use in the passphrase. Defaults to 4.
+* Path to words file. Defaults to `/usr/share/dict/words`.
+
+### Example
+
+`passwordgen -w 5 /usr/share/dict/american-english`