diff options
| author | Michaël Ball <michael.ball@gmail.com> | 2016-09-04 22:50:17 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-04 22:50:17 +0100 |
| commit | 181f76b7ffec963573e9997675e8207f0fb48661 (patch) | |
| tree | dae621b162425574e4b8a0e54ea9d99de48e44de /README.md | |
| parent | 21eb15e87b42728d6fd3de6cbc256dde62fbacfd (diff) | |
Update with usage instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -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` |