From 8626cdfa3e103a3b0e3a8f54e8f66f5801851179 Mon Sep 17 00:00:00 2001
From: Sparkenstein <zetabytes.pp@gmail.com>
Date: Mon, 12 Oct 2020 22:23:21 +0530
Subject: [PATCH] feat (docs): added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15a4dbb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# passgen
+
+A simple random password generator.
+
+## Usage
+```
+passgen 1.0
+@Sparkenstein
+Generate Random password on command line
+
+USAGE:
+    passgen [OPTIONS]
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+
+OPTIONS:
+    -i, --include <include>    include numbers/upppercase/lowercase/symbols in generated string [default: nlus]
+    -l, --length <length>      include lowercase characters in generated string [default: 16]
+```
+
+## Example
+
+Generate random password with default settings (16 char long string with number, lowercase, uppercase, and symbols):
+```
+passgen
+```
+
+Change length of password to 20 chars:
+```
+passgen -l 20
+```
+
+Use only Lowercase and Uppercase characters
+```
+passgen -i lu
+```
+
+Generate only number, symbols and uppercase with length of 25
+```
+passgen -l 25 -i nsu
+```
\ No newline at end of file