aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Daniel Washburn <daniel@washburn.at> 2021-02-21 11:52:45 -0500
committerGravatar Daniel Washburn <daniel@washburn.at> 2021-02-21 11:52:45 -0500
commit623352cdd7f83271dc235dd5073bdfdaafc573fa (patch)
treee261e1c6deb85f501b614c8533d6f1140fabf16f /README.md
parent644bf682b90b67773f54163509d6962eebf3daea (diff)
Add ability to specify the number of words in each pet name
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index 88258d8..29d3ddd 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Random Pet Name Generator
-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.
+This tool uses the [PGP Biometric word list](https://en.wikipedia.org/wiki/PGP_word_list) to generate random n-word pet names, a la Docker friendly names.
## Installation
@@ -9,13 +9,12 @@ This tool uses the [PGP Biometric word list](https://en.wikipedia.org/wiki/PGP_w
## Usage
- ./pet_names [n]
+ ./pet_names [m] [n]
- Generate n random pet names. If no value is supplied, the tool defaults to generating a single pet name.
+ Generate m random pet names, n words in length. If no value is supplied, the tool defaults to generating one two-word pet name.
## Example
- ./pet_names 3
- burbank_provincial
- retouch_therapist
- slowdown_millionaire
+ ./pet_names 2 3
+ talon_publisher_scenic
+ trauma_ohio_zulu