From 181f76b7ffec963573e9997675e8207f0fb48661 Mon Sep 17 00:00:00 2001 From: Michaël Ball Date: Sun, 4 Sep 2016 22:50:17 +0100 Subject: Update with usage instructions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') 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` -- cgit v1.2.3