pokemon_name_generator 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0bd26e0cfe791878ceb1eb08e95f0139c415093150893054bea601096f831ef4
4
- data.tar.gz: f2a932d88d8b8dc9e72062a0f690624dbecdb442a7823c885cff7e153fb48eba
3
+ metadata.gz: 9edb273da4cdabb9557232e24699f3f82e926676974c2ef1c81cce52b6e871cf
4
+ data.tar.gz: f4e6bef343c36aca003243b4b0cbfbc50ad1afeabdd9cf1e5e7ceba8f3a95209
5
5
  SHA512:
6
- metadata.gz: 954cf9f44f995cdd5a85077fd8eb91fe878d5310b0ea14dc705e0cce151b3d15c667ff9dd116e08cc2168ca51e3857060ac67336481dde15f0d251fab6b983cf
7
- data.tar.gz: d2dcebcfca256af8e10aa48a4799c49776c9a68e74479b5581e5997d019a370819f4a34e19bdb36e70971a64057a60d0c5de06c90ea0434dad4b84a096521106
6
+ metadata.gz: f404f12c3cb2d950e1e9c971bddf78e6aa428d1c2429859787661facdfe2da88b40688ea7c14740e79e07c051f23a3d234a5167252ee1384841e29be099b6268
7
+ data.tar.gz: 20fc66d841cda24aac7b971b676a2ceaaa9479ae63201d7a9fb2ea819b88408a98946d6d99bb66b521ec33316610906fe6690a1ac74e73705aaa681cac3c11de
data/README.md CHANGED
@@ -1,44 +1,58 @@
1
1
  # Pokémon Name Generator
2
2
 
3
+ ![Lint](https://github.com/tony-rowan/pokemon-name-generator/actions/workflows/lint.yml/badge.svg)
4
+ ![Test](https://github.com/tony-rowan/pokemon-name-generator/actions/workflows/test.yml/badge.svg)
5
+ [![Gem Version](https://badge.fury.io/rb/pokemon_name_generator.svg)](https://badge.fury.io/rb/pokemon_name_generator)
6
+
3
7
  A command line ruby utility to generate fake (and sometimes accidentally real)
4
8
  Pokémon names.
5
9
 
10
+ ## Installation
11
+
12
+ Install the utility with
13
+
14
+ ```bash
15
+ $ gem install pokemon_name_generator
16
+ ```
17
+
6
18
  ## Usage
7
19
 
20
+ Once installed, you will have the command `pokeng` available.
21
+
8
22
  Usage can be very simple.
9
23
 
10
24
  ```bash
11
- $ bin/pokeng generate
25
+ $ pokeng generate
12
26
  ```
13
27
 
14
28
  You can choose between algorithms.
15
29
 
16
30
  ```bash
17
- $ bin/pokeng generate --algorithm=naive
18
- $ bin/pokeng generate --algorithm=markov
31
+ $ pokeng generate --algorithm=naive
32
+ $ pokeng generate --algorithm=markov
19
33
  ```
20
34
 
21
35
  Some algorithms have additional configuration options.
22
36
 
23
37
  ```bash
24
- $ bin/pokeng generate --algorithm=markov --context=2
38
+ $ pokeng generate --algorithm=markov --context=2
25
39
  ```
26
40
 
27
41
  You can also produce a number of names at once.
28
42
  Useful for exporting to other apps.
29
43
 
30
44
  ```bash
31
- $ bin/pokeng generate --algorithm=markov --context=3 --number=100000 > generated_names.txt
45
+ $ pokeng generate --algorithm=markov --context=3 --number=100000 --quiet > generated_names.txt
32
46
  ```
33
47
 
34
48
  The default options are chosen to produce the most realistic names.
35
49
 
36
- ## Testing the Algorithm
50
+ ## Testing an Algorithm
37
51
 
38
52
  You can put an algorithm through a testbed to find out how well it performs.
39
53
  It counts how many times an actual Pokémon name is produced (from the test and
40
54
  training data seperately) and how often a overly long or short name is produced.
41
55
 
42
56
  ```bash
43
- $ bin/pokeng test --algorithm=markov --context=2 --number=500000
57
+ $ pokeng test --algorithm=markov --context=2 --number=500000
44
58
  ```