aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Daniel Washburn <daniel@washburn.at> 2020-05-09 14:31:01 -0400
committerGravatar Daniel Washburn <daniel@washburn.at> 2020-05-09 14:44:57 -0400
commit644bf682b90b67773f54163509d6962eebf3daea (patch)
tree543237271e5005fba23457fe4b0f435f47a8f49e /README.md
parent917b18face67da9ea20755fbc860b52d5e65ae6b (diff)
Update README.md with installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files 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