aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 88258d8f88f4f6c4feea9b7fa854f78fbfbc4f2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 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.

## Installation

    pip3 install -r requirements.txt


## Usage

    ./pet_names [n]

        Generate n random pet names. If no value is supplied, the tool defaults to generating a single pet name.

## Example

    ./pet_names 3
    burbank_provincial
    retouch_therapist
    slowdown_millionaire