From 7d12e29d4c5689ce10ee5d11a56c10c3efe83055 Mon Sep 17 00:00:00 2001
From: Sakuhl <2012collector@gmail.com>
Date: Thu, 26 Jan 2017 11:59:05 +0000
Subject: [PATCH] Add readme.md

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e90df79
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+pwgenr
+====
+[![Crates.io](https://img.shields.io/crates/v/pwgenr.svg)](https://crates.io/crates/pwgenr)
+
+Random password generator (mainly for use with a password manager).
+
+## Example
+```bash
+$ pwgenr -lc box -- 12 6
+◭┫▹◨┒◳┟┰┒┴┷○
+╓┭◷▱╙▙╼○▒┆◌╰
+▯◳▥◱◛═▉◆┴◽▌╓
+◶◓┆│┓╰┶◑▶◉◁┓
+┶┬◪◶◞┼▰▏┞╳╋▩
+▌┖╅┺┶◫┺┹◪┲┧┦
+```
+
+## Options
+
+You can check by typing `pwgenr -h`:
+
+```
+USAGE:
+    pwgenr [FLAGS] [OPTIONS] [--] [ARGS]
+
+FLAGS:
+    -a, --ascii        Only use ASCII characters
+    -b, --clipboard    Copy first password to clipboard (requires xclip)
+    -h, --help         Prints help information
+    -l, --list         Print the generated passwords in a list (default: columns)
+    -v                 Set the logging level
+    -V, --version      Prints version information
+
+OPTIONS:
+    -c <categories>...                           Categories to be used [values: ascii, symbols, math, arrows, dingbat, games, box, tech]
+    -s, --column-separator <column-separator>    Separator between columns [default:  ]
+
+ARGS:
+    <LENGTH>    The length of the generated passwords [default: 64]
+    <AMOUNT>    How many passwords should be generated [default: 12]
+```
+
+## Installation
+
+You can use the `cargo install` command:
+
+    $ cargo install pwgenr
+
+or a classic build and run:
+
+```bash
+$ git clone https://gitlab.com/Sakuhl/pwgenr
+$ cd pwgenr
+$ cargo build --release
+$ cp target/release/pwgenr ~/.bin # assuming .bin is in your path
+```
\ No newline at end of file