diff --git a/README.md b/README.md index 419f9d1..0e5eaea 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ -Alea -==== +# Alea +### A diceware passphrase generator -a diceware passphrase generator +### Usage +Run `alea -h` for help + +Example usage: + + $ ./alea + doso epurai usci selve dirupo bs + + $ ./alea --phrases 3 + ditelo vita moriro sf sedare selcia + pedino nido ardori visti curato menano + brullo merlo cicli sposti scorga mode + + $ ./alea --phraselength 8 + poi dalle stanze chinai donato timori sterza carene + +### License +Dual licensed under the MIT and GPL licenses: +http://www.opensource.org/licenses/mit-license.php +http://www.gnu.org/licenses/gpl.html