aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOskari Timperi <oswjk@users.noreply.github.com>2015-09-17 15:40:04 +0300
committerOskari Timperi <oswjk@users.noreply.github.com>2015-09-17 15:40:04 +0300
commit5d0c71ff11d480be5530918cb83d0a5755f1518e (patch)
tree700c4c9420caf521a3eba6d8e0e74e7ddaead2b7
parent9198437e42d0f299190de178371f1f28dc362854 (diff)
downloaddiceware-5d0c71ff11d480be5530918cb83d0a5755f1518e.tar.gz
diceware-5d0c71ff11d480be5530918cb83d0a5755f1518e.zip
Update README.md
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6d96c5c..23d3cfb 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,26 @@
# Diceware
-A simple tool to generate [diceware](http://world.std.com/~reinhold/diceware.html)
+A simple command line tool to generate [diceware](http://world.std.com/~reinhold/diceware.html)
passwords from diceware wordlists.
+# Usage
+
+The program needs a word list file (which you can download from the link above) to
+work. The command to generate a password using a wordlist named `diceware.wordlist.asc` is:
+
+ $ diceware -d diceware.wordlist.asc
+
+If you need more or less words than the default, you can give the amount of words:
+
+ $ diceware -d diceware.wordlist.asc -n 12
+
+On non-windows systems you can select which device is used for random data:
+
+ $ diceware -d diceware.wordlist.asc -r /dev/random
+
+The default source is `/dev/urandom`. On Windows the program uses the Windows cryptography
+API (`CryptGenRandom` and friends).
+
# Building
To build on a unixy system: