diff options
| -rw-r--r-- | README.md | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -1,9 +1,21 @@ # Random Pet Name Generator -This tool uses the PGP Biometric Wordlist to generate random pet names +This tool uses the [PGP Biometric word list](https://en.wikipedia.org/wiki/PGP_word_list) to generate random two-word pet names, a la Docker friendly names. + +## Installation + + pip3 install -r requirements.txt + ## Usage - `pet_names [n]` + ./pet_names [n] + + Generate n random pet names. If no value is supplied, the tool defaults to generating a single pet name. + +## Example - Generate n random pet names. If no value is supplied, the tool defaults to generating a single pet name. + ./pet_names 3 + burbank_provincial + retouch_therapist + slowdown_millionaire |