initial version with README

Author: paulsuh

README.md

@@ -1,2 +1,53 @@
-# memorable-password-gen
-Generate random passwords based on compound nouns. 
+# Memorable Password Generator
+
+This is a simple script to generate random passwords based on open two 
+word compound nouns, like "writing tablet". This makes them easy to 
+remember since they represent a single concept, unlike a pair of 
+unrelated words. The punctuation is chosen from the set of characters 
+that can be typed on an iPhone using the numeric mode of the standard 
+keyboard. This makes it easy to type on an iPhone.
+
+## Usage
+
+    ./memorable_password_gen <num passwords (def=10)> <min len (def=15)>
+
+The generated passwords will be of the form:
+
+    [word1][digit][punctuation][word2]
+
+By default the script will generate 10 potential passwords that are 
+at least 15 characters in length. One example run produces: 
+
+    $ ./memorable_password_gen.sh 
+    border9(terrier
+    psychological4(counseling
+    antisterility4'factor
+    theological6-seminary
+    stilbine3.color
+    mitigating9&circumstances
+    pondus2-medicinale
+    repeat7.verbatim
+    writing6$tablet
+    short4!covering
+
+You can then select one of them that suits you as your new password. 
+Capital letters are not generated automatically, but you can place one  
+anywhere within the password. 
+
+## Underlying Details
+
+The open compound nouns are taken from the file `256772co.mpo`, part 
+of the [Moby list][link01]. The words in the file were filtered to  
+remove compound nouns where one of the parts is less than four 
+characters long, has more than two parts, or is a proper noun. 
+
+The script runs entirely locally and does not communicate with any
+remote systems. You can be confident that any password you generate
+will be completely private. 
+
+## License
+
+Distributed under the terms of the `MIT` license,
+`memorable-password-gen` is free and open source software.
+
+[link01]: https://ai1.ai.uga.edu/ftplib/natural-language/moby/moby.tar.Z