add README

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5fc2223
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# rofi-pass
+
+#### bash script to handle pass storages in a convenient way
+
+## rofi-pass has the following features:
+
+* Auto Type User and Password. Format of password files are expected to be like:
+```
+foobarmysecurepassword
+UserName: MyUser
+URL http://my.url.foo
+```
+* Auto Typing of more than one field. This expects numbered fields in password file:
+```
+foobarmysecurepassword
+1 UserName: MyUser
+2 SomeField: foobar
+3 AnotherField: barfoo
+URL http://my.url.foo
+```
+* Open URLs of entries with hotkey
+* Add new Entries to Password Storage
+* Edit existing Entries
+
+## Requirements
+* pass
+* sed
+* rofi
+* wmctrl
+* xprop
+* xdotool
+* awk
+* bash