aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ac13ed6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# LockPassword - a simple terminal password manager
+## Synopsis
+### lpass [command]
+
+## Commands
+### --init
+Initialize password bank. Before use a LockPassword you must be run this command.
+### -c
+In developing...
+### -e name
+Edit a existing password in 'name'.
+### -g [number-of-symbols] name
+Generate a new password using length [number-of-symbols] and insert in name. Without [number-of-symbols] default generate 10 chars.
+### -i name
+Create 'name' store and insert your password there.
+### -R name
+Remove 'name' store from the password bank.
+
+## How are passwords stored?
+For now, passwords are kept in clear еtext. We will add password encryption in the next update
+
+## Guide
+Coming soon...