From 644bf682b90b67773f54163509d6962eebf3daea Mon Sep 17 00:00:00 2001 From: Daniel Washburn Date: Sat, 9 May 2020 14:31:01 -0400 Subject: Update README.md with installation instructions --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ef36b6..88258d8 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.2