Added help from command to readme

TomHotston · Aug 1, 2020 · b28731e · b28731e
1 parent da98e8c
commit b28731e
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
 # pswd
 A tool for selecting characters from passwords
+
+## Help
+### usage
+pswd [FLAGS] \<PASSWORD\> [POSITION]...
+
+### flags
+-h, --help       Prints help information <br>
+-P, --pipe       Take \<PASSWORD\> value from stdin, allowing for piped input <br>
+-V, --version    Prints version information
+
+### args
+\<PASSWORD\>       The password of which charaters are to be selected from. <br>
+\<POSITION\>...    The position (integer) of the character to select (starting at 1)