aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichaël Ball <michael.ball@gmail.com>2016-09-05 21:50:34 +0100
committerMichaël Ball <michael.ball@gmail.com>2016-09-05 21:50:34 +0100
commit2b88dc3ca3b6507e39226bdb37a68806feb77a36 (patch)
tree27de4ff20921069fadb37283935b24a2d573483f
parent181f76b7ffec963573e9997675e8207f0fb48661 (diff)
Update readme
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index a1815a9..fff1066 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
# passphrasegen
-A passphrase generator written in Go
+A passphrase generator written in Go.
## Usage
-Install with by running `go install`, or build and run by running `go build`.
+Install by running `go install`, or build locally by running `go build`.
Generate a passphrase by running `passphrasegen`.
@@ -12,4 +12,6 @@ Optional arguments:
### Example
-`passwordgen -w 5 /usr/share/dict/american-english`
+Generate a passphrase of 5 words using the american english wordlist:
+
+ $ passwordgen -w 5 /usr/share/dict/american-english \ No newline at end of file