random-words 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1422c6aec433ac2d914761363e469403476d7dd95ada1506dedab19c8824b15
-  data.tar.gz: dbc0c6de7230b951269455ca632f32249e2b08e22a6ac5bb8b3f0279951fb3f0
+  metadata.gz: 93fe5e094ab5456c93398e2e51af865c0a0c6a8846ed5fcf21a47a4369ca8932
+  data.tar.gz: 2971b34d0df1683753112843eacbef9f1412f4241434739ef59197fa259d5290
 SHA512:
-  metadata.gz: fdb6f7b4779aa9c27c07df7d77ffd02a1f8715c5987f89da4bdeb666fc6f548c9ce9f795874125cda44da9fa89fc0629cdd1865ed4f1121340b1c8af68e4ea51
-  data.tar.gz: b565c7dc5d1f8c97130225e5b3aa5b79b839421bc74ff333fd3ce476c8aaf604d80e16a9453dcef31d4c4809c92df437b9440455ab6eeb66e14d5f12bad24706
+  metadata.gz: d839ddb848ab02efb2ecd3e8c46ebd9b5f37c01537612d0e297d779fc67b109fd8c8f8456aaf3b7686fb98e5a35717ca22331df2dc37eaebe6cdbc6636eb91d6
+  data.tar.gz: 8549612fa5fd2b237a775783a18fda7c58737fcc48434cfdd8d69567d69c158325738073606e2599b656dc3847d2caef38df50902876a44bd8c80aa47d853f45

data/.rspec_status

@@ -1,39 +1,148 @@
-example_id                         | status | run_time        |
----------------------------------- | ------ | --------------- |
-./spec/generator_spec.rb[1:1:1]    | passed | 0.00343 seconds |
-./spec/generator_spec.rb[1:2:1]    | passed | 0.00242 seconds |
-./spec/generator_spec.rb[1:3:1]    | passed | 0.0016 seconds  |
-./spec/generator_spec.rb[1:4:1]    | passed | 0.00094 seconds |
-./spec/generator_spec.rb[1:5:1]    | passed | 0.00259 seconds |
-./spec/generator_spec.rb[1:5:2]    | passed | 0.00107 seconds |
-./spec/generator_spec.rb[1:5:3]    | passed | 0.00061 seconds |
-./spec/generator_spec.rb[1:5:4]    | passed | 0.00099 seconds |
-./spec/generator_spec.rb[1:5:5]    | passed | 0.00092 seconds |
-./spec/generator_spec.rb[1:6:1]    | passed | 0.00113 seconds |
-./spec/generator_spec.rb[1:7:1]    | passed | 0.00059 seconds |
-./spec/generator_spec.rb[1:7:2]    | passed | 0.00129 seconds |
-./spec/generator_spec.rb[1:7:3]    | passed | 0.00067 seconds |
-./spec/generator_spec.rb[1:8:1]    | passed | 0.00103 seconds |
-./spec/generator_spec.rb[1:9:1]    | passed | 0.00069 seconds |
-./spec/generator_spec.rb[1:10:1]   | passed | 0.00071 seconds |
-./spec/generator_spec.rb[1:11:1]   | passed | 0.0005 seconds  |
-./spec/generator_spec.rb[1:12:1]   | passed | 0.00224 seconds |
-./spec/generator_spec.rb[1:13:1]   | passed | 0.0005 seconds  |
-./spec/generator_spec.rb[1:13:2]   | passed | 0.00055 seconds |
-./spec/generator_spec.rb[1:14:1]   | passed | 0.0005 seconds  |
-./spec/generator_spec.rb[1:14:2]   | passed | 0.00077 seconds |
-./spec/hello_world_spec.rb[1:1]    | passed | 0.00003 seconds |
-./spec/initialize_spec.rb[1:1:1]   | passed | 0.00052 seconds |
-./spec/initialize_spec.rb[1:1:2]   | passed | 0.00049 seconds |
-./spec/initialize_spec.rb[1:1:3]   | passed | 0.00048 seconds |
-./spec/initialize_spec.rb[1:1:4]   | passed | 0.00043 seconds |
-./spec/initialize_spec.rb[1:1:5:1] | passed | 0.00073 seconds |
-./spec/initialize_spec.rb[1:1:6:1] | passed | 0.00054 seconds |
-./spec/module_spec.rb[1:1]         | passed | 0.00059 seconds |
-./spec/string_spec.rb[1:1:1]       | passed | 0.00003 seconds |
-./spec/string_spec.rb[1:2:1]       | passed | 0.00002 seconds |
-./spec/string_spec.rb[1:2:2]       | passed | 0.00002 seconds |
-./spec/string_spec.rb[1:2:3]       | passed | 0.00002 seconds |
-./spec/string_spec.rb[1:3:1]       | passed | 0.00005 seconds |
-./spec/string_spec.rb[1:4:1]       | passed | 0.00002 seconds |
-./spec/string_spec.rb[1:5:1]       | passed | 0.00003 seconds |
+example_id                             | status | run_time        |
+-------------------------------------- | ------ | --------------- |
+./spec/config_spec.rb[1:1:1:1]         | passed | 0.0023 seconds  |
+./spec/config_spec.rb[1:1:1:2]         | passed | 0.00077 seconds |
+./spec/config_spec.rb[1:1:2:1]         | passed | 0.00302 seconds |
+./spec/config_spec.rb[1:2:1:1]         | passed | 0.0046 seconds  |
+./spec/config_spec.rb[1:2:1:2]         | passed | 0.00346 seconds |
+./spec/config_spec.rb[1:2:1:3]         | passed | 0.00448 seconds |
+./spec/config_spec.rb[1:3:1]           | passed | 0.0204 seconds  |
+./spec/config_spec.rb[1:3:2]           | passed | 0.01628 seconds |
+./spec/config_spec.rb[1:3:3]           | passed | 0.01354 seconds |
+./spec/config_spec.rb[1:4:1:1]         | passed | 0.0041 seconds  |
+./spec/config_spec.rb[1:4:2:1]         | passed | 0.00745 seconds |
+./spec/config_spec.rb[1:4:3:1]         | passed | 0.00364 seconds |
+./spec/config_spec.rb[1:5:1:1]         | passed | 0.0102 seconds  |
+./spec/config_spec.rb[1:5:2:1]         | passed | 0.01021 seconds |
+./spec/config_spec.rb[1:6:1:1]         | passed | 0.0015 seconds  |
+./spec/config_spec.rb[1:6:2:1]         | passed | 0.00163 seconds |
+./spec/generator_spec.rb[1:1:1]        | passed | 0.00742 seconds |
+./spec/generator_spec.rb[1:1:2]        | passed | 0.00709 seconds |
+./spec/generator_spec.rb[1:2:1]        | passed | 0.00834 seconds |
+./spec/generator_spec.rb[1:3:1]        | passed | 0.0077 seconds  |
+./spec/generator_spec.rb[1:4:1]        | passed | 0.00719 seconds |
+./spec/generator_spec.rb[1:4:2]        | passed | 0.00756 seconds |
+./spec/generator_spec.rb[1:4:3]        | passed | 0.00744 seconds |
+./spec/generator_spec.rb[1:4:4]        | passed | 0.0082 seconds  |
+./spec/generator_spec.rb[1:4:5]        | passed | 0.00691 seconds |
+./spec/generator_spec.rb[1:5:1]        | passed | 0.00697 seconds |
+./spec/generator_spec.rb[1:6:1]        | passed | 0.00765 seconds |
+./spec/generator_spec.rb[1:6:2]        | passed | 0.00823 seconds |
+./spec/generator_spec.rb[1:6:3]        | passed | 0.00667 seconds |
+./spec/generator_spec.rb[1:7:1]        | passed | 0.02583 seconds |
+./spec/generator_spec.rb[1:8:1]        | passed | 0.03449 seconds |
+./spec/generator_spec.rb[1:9:1]        | passed | 0.0082 seconds  |
+./spec/generator_spec.rb[1:10:1]       | passed | 0.00917 seconds |
+./spec/generator_spec.rb[1:11:1]       | passed | 0.01607 seconds |
+./spec/generator_spec.rb[1:12:1]       | passed | 0.00828 seconds |
+./spec/generator_spec.rb[1:12:2]       | passed | 0.00896 seconds |
+./spec/generator_spec.rb[1:13:1]       | passed | 0.01007 seconds |
+./spec/generator_spec.rb[1:13:2]       | passed | 0.00948 seconds |
+./spec/generator_spec.rb[1:14:1]       | passed | 0.01335 seconds |
+./spec/generator_spec.rb[1:15:1]       | passed | 0.02646 seconds |
+./spec/generator_spec.rb[1:15:2]       | passed | 0.01 seconds    |
+./spec/generator_spec.rb[1:15:3]       | passed | 0.00972 seconds |
+./spec/generator_spec.rb[1:15:4]       | passed | 0.0307 seconds  |
+./spec/generator_spec.rb[1:15:5]       | passed | 0.02688 seconds |
+./spec/generator_spec.rb[1:16:1]       | passed | 0.00983 seconds |
+./spec/generator_spec.rb[1:16:2]       | passed | 0.01314 seconds |
+./spec/generator_spec.rb[1:16:3]       | passed | 0.01308 seconds |
+./spec/hash_spec.rb[1:1:1]             | passed | 0.00005 seconds |
+./spec/hash_spec.rb[1:1:2]             | passed | 0.00004 seconds |
+./spec/hash_spec.rb[1:2:1]             | passed | 0.00003 seconds |
+./spec/hash_spec.rb[1:2:2]             | passed | 0.00002 seconds |
+./spec/hello_world_spec.rb[1:1]        | passed | 0.00002 seconds |
+./spec/html2markdown_spec.rb[1:1:1]    | passed | 0.00015 seconds |
+./spec/html2markdown_spec.rb[1:1:2]    | passed | 0.00006 seconds |
+./spec/html2markdown_spec.rb[1:1:3]    | passed | 0.00144 seconds |
+./spec/html2markdown_spec.rb[1:2:1]    | passed | 0.00007 seconds |
+./spec/html2markdown_spec.rb[1:2:2]    | passed | 0.00004 seconds |
+./spec/html2markdown_spec.rb[1:2:3]    | passed | 0.00006 seconds |
+./spec/html2markdown_spec.rb[1:2:4]    | passed | 0.00004 seconds |
+./spec/html2markdown_spec.rb[1:2:5]    | passed | 0.00004 seconds |
+./spec/html2markdown_spec.rb[1:2:6]    | passed | 0.00005 seconds |
+./spec/html2markdown_spec.rb[1:2:7]    | passed | 0.00004 seconds |
+./spec/html2markdown_spec.rb[1:3:1]    | passed | 0.00006 seconds |
+./spec/html2markdown_spec.rb[1:3:2]    | passed | 0.00006 seconds |
+./spec/html2markdown_spec.rb[1:4:1]    | passed | 0.00005 seconds |
+./spec/initialize_spec.rb[1:1:1]       | passed | 0.01003 seconds |
+./spec/initialize_spec.rb[1:1:2]       | passed | 0.00886 seconds |
+./spec/initialize_spec.rb[1:1:3]       | passed | 0.00738 seconds |
+./spec/initialize_spec.rb[1:1:4]       | passed | 0.00817 seconds |
+./spec/initialize_spec.rb[1:1:5:1]     | passed | 0.00948 seconds |
+./spec/initialize_spec.rb[1:1:6:1]     | passed | 0.0086 seconds  |
+./spec/integer_spec.rb[1:1:1]          | passed | 0.00005 seconds |
+./spec/integer_spec.rb[1:1:2]          | passed | 0.00003 seconds |
+./spec/integer_spec.rb[1:1:3]          | passed | 0.00003 seconds |
+./spec/integer_spec.rb[1:1:4]          | passed | 0.00003 seconds |
+./spec/integer_spec.rb[1:1:5]          | passed | 0.00004 seconds |
+./spec/integer_spec.rb[1:1:6]          | passed | 0.00002 seconds |
+./spec/integer_spec.rb[1:2:1]          | passed | 0.00004 seconds |
+./spec/lorem_markdown_spec.rb[1:1:1]   | passed | 0.01022 seconds |
+./spec/lorem_markdown_spec.rb[1:1:2:1] | passed | 0.01036 seconds |
+./spec/lorem_markdown_spec.rb[1:2:1]   | passed | 0.01048 seconds |
+./spec/lorem_markdown_spec.rb[1:2:2]   | passed | 0.01073 seconds |
+./spec/lorem_markdown_spec.rb[1:2:3]   | passed | 0.01021 seconds |
+./spec/lorem_markdown_spec.rb[1:2:4]   | passed | 0.00935 seconds |
+./spec/lorem_markdown_spec.rb[1:2:5]   | passed | 0.00986 seconds |
+./spec/lorem_markdown_spec.rb[1:2:6]   | passed | 0.00911 seconds |
+./spec/module_spec.rb[1:1]             | passed | 0.00004 seconds |
+./spec/source_spec.rb[1:1:1]           | passed | 0.00129 seconds |
+./spec/source_spec.rb[1:2:1]           | passed | 0.00012 seconds |
+./spec/source_spec.rb[1:3:1]           | passed | 0.001 seconds   |
+./spec/source_spec.rb[1:4:1]           | passed | 0.00104 seconds |
+./spec/source_spec.rb[1:4:2]           | passed | 0.00094 seconds |
+./spec/source_spec.rb[1:4:3:1]         | passed | 0.00092 seconds |
+./spec/string_spec.rb[1:1:1]           | passed | 0.00003 seconds |
+./spec/string_spec.rb[1:2:1]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:2:2]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:2:3]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:3:1]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:4:1]           | passed | 0.00003 seconds |
+./spec/string_spec.rb[1:5:1]           | passed | 0.00003 seconds |
+./spec/string_spec.rb[1:6:1]           | passed | 0.00003 seconds |
+./spec/string_spec.rb[1:7:1]           | passed | 0.00004 seconds |
+./spec/string_spec.rb[1:7:2]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:7:3]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:8:1]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:8:2]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:8:3]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:9:1]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:9:2]           | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:10:1]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:10:2]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:10:3]          | passed | 0.00006 seconds |
+./spec/string_spec.rb[1:10:4]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:10:5]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:11:1]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:11:2]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:11:3]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:11:4]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:11:5]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:12:1]          | passed | 0.00029 seconds |
+./spec/string_spec.rb[1:12:2]          | passed | 0.00014 seconds |
+./spec/string_spec.rb[1:12:3]          | passed | 0.00016 seconds |
+./spec/string_spec.rb[1:13:1]          | passed | 0.00004 seconds |
+./spec/string_spec.rb[1:13:2]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:13:3]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:13:4]          | passed | 0.00003 seconds |
+./spec/string_spec.rb[1:14:1]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:14:2]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:14:3]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:14:4]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:14:5]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:15:1]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:15:2]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:15:3]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:15:4]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:16:1]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:16:2]          | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:16:3]          | passed | 0.00002 seconds |
+./spec/table_cleanup_spec.rb[1:1:1]    | passed | 0.00006 seconds |
+./spec/table_cleanup_spec.rb[1:1:2]    | passed | 0.00003 seconds |
+./spec/table_cleanup_spec.rb[1:2:1]    | passed | 0.00002 seconds |
+./spec/table_cleanup_spec.rb[1:3:1]    | passed | 0.00002 seconds |
+./spec/table_cleanup_spec.rb[1:3:2]    | passed | 0.00002 seconds |
+./spec/table_cleanup_spec.rb[1:3:3]    | passed | 0.00002 seconds |
+./spec/table_cleanup_spec.rb[1:4:1]    | passed | 0.00008 seconds |
+./spec/table_cleanup_spec.rb[1:4:2]    | passed | 0.00006 seconds |

data/.rubocop.yml

@@ -62,3 +62,4 @@ Style/SpecialGlobalVars:
 # URISchemes: http, https
 Layout/LineLength:
   Max: 135
+  Exclude: bin/randw

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+### 1.0.6
+
+2025-04-14 08:45
+
+#### NEW
+
+- Add dirtywords
+- Markdown generator with table cleanup
+
+#### FIXED
+
+- Better use of conjunctions
+
+### 1.0.5
+
+2025-04-13 08:36
+
+#### NEW
+
+- 1984 dictionary
+- Doctor dictionary
+- Added Alice in Wonderland dictionary
+- Add Spanish
+
+#### IMPROVED
+
+- Config methods
+- Convert integers to strings using a basic places configuration file instead of requiring each line in a config file to spell out a number
+- CLI test uses all languages
+- Add prepositions
+- Capitalize first letter only, igoring opening punctuation
+- Terminators configuration allows for opening and closing terminators
+- More tests
+- Make extended punctuation like quotes optional
+- Expand documentation
+- Expand test coverage
+
+#### FIXED
+
+- Capitalize method on empty string
+- Fix_caps method on empty string
+
 ### 1.0.3
 
 2025-04-09 09:00

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    random-words (1.0.5)
+    random-words (1.0.6)
+      nokogiri (~> 1.12)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +17,8 @@ GEM
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
     multi_json (1.15.0)
+    nokogiri (1.18.1-arm64-darwin)
+      racc (~> 1.4)
     parallel (1.26.3)
     parse_gemspec (1.0.0)
     parse_gemspec-cli (1.0.0)

data/README.md

@@ -1,6 +1,6 @@
 
 
-[![RubyGems.org](https://img.shields.io/gem/v/snibbets)](https://rubygems.org/gems/snibbets)
+[![RubyGems.org](https://img.shields.io/gem/v/random-words)](https://rubygems.org/gems/random-words)
 
 A random text (Lorem Ipsum) generator.
 
@@ -8,7 +8,11 @@ A random text (Lorem Ipsum) generator.
 
     gem install random-words
 
-Depending on your setup, you may need `gem install --user-install random-words`, or in worst case scenario, `sudo gem install random-words`. You can also use `brew gem install random-words` if you use [Homebrew](https://brew.sh).
+Depending on your setup, you may need
+`gem install --user-install random-words`, or in
+worst case scenario, `sudo gem install random-words`.
+You can also use `brew gem install random-words` if
+you use [Homebrew](https://brew.sh).
 
 ### CLI
 
@@ -16,24 +20,169 @@ The gem installs a binary `randw`. It can generate random characters, sentences,
 
 ```console
 Usage: randw [options]
-Options:
+OPTIONS:
     -S, --source [SOURCE]            Specify the source language (default: latin)
     -l [short|medium|long|very_long],
         --length                     Specify the length of the sentence
         --graf-length [NUMBER]       Specify the number of sentences in a paragraph
     -s, --sentences [NUMBER]         Generate random sentences
+GENERATORS:
     -p, --paragraphs [NUMBER]        Generate random paragraphs
     -w, --words [NUMBER]             Generate random words
     -c, --characters [NUMBER]        Generate random characters
+    -m, --markdown SETTINGS          Generate random markdown text, comma separated string like "latin,10,all"
         --password                   Generate a random password
+PASSWORD OPTIONS:
         --separator [CHAR]           Specify the separator character for the password
-    -n, --no-whitespace              Specify whether to remove whitespace in generated text (characters only)
+        --[no-]extended              Specify whether to use extended punctuation in generated text
+    -n, --[no-]whitespace            Specify whether to remove whitespace in generated text (characters only)
+DICTIONARIES:
+        --list-dictionaries          List available dictionaries
+        --create-dictionary [NAME]   Create a new dictionary
+OTHER OPTIONS:
     -d, --debug                      Enable debug mode, displays sentence/word/character counts
     -h, --help                       Display this help message
     -v, --version                    Display the version
     -t, --test                       Run the full debug test
 ```
 
+#### Generating Markdown text
+
+The `--markdown` flag takes a SETTINGS argument. This is a
+comma- or slash-separated string that determines the
+elements to include.
+
+First, the source language (defaults to latin), then the
+length of paragraphs and tables: e.g. `english/medium`. You
+can add any digits to determine how many paragraps are
+generated (default 5), e.g. `corporate/medium/10`.
+
+Then you can add individual elements, or use `/all` to
+trigger all elements. The elements available are:
+
+| trigger | element                   |
+| :------ | :------------------------ |
+| dec     | add em and strong         |
+| link    | add links                 |
+| ul      | add unordered lists       |
+| ol      | add ordered lists         |
+| dl      | add definition lists      |
+| bq      | add block quotes          |
+| code    | add code spans and blocks |
+| mark    | add ==highlights==        |
+| headers | add headlines             |
+| image   | add images                |
+| table   | add tables                |
+
+The number of elements inserted depends on the length you specify.
+
+Example commands:
+
+    $ randw -m "latin/10/ol/dl/table"
+    $ randw -m "english/5/all"
+
+
+#### Creating A New Dictionary
+
+You can add your own sources for generating your random
+text. A dictionary is a directory containing several text
+files, one for each part of speech that RandomWords uses.
+All of the parts must exist. The directory name is the same
+as the name of the dictionary.
+
+User dictionaries must be stored in `~/.config/random-words/words/[NAME]`.
+
+The easiest way to generate a new language is to use the CLI:
+
+```console
+randw --create-dictionary [NAME]
+```
+
+Once this command is run, a new directory in
+`~/.config/random-words/words` will be created containing
+all of the necessary files with English defaults. Simply
+edit these files, and then you'll be able to call the
+language by its name (or triggers defined in the config, see
+below). If a language of the same name exists, missing files
+will be filled in, but existing files will not be
+overwritten.
+
+The necessary files are:
+
+```console
+adjectives.txt
+adverbs.txt
+articles-plural.txt
+articles-singular.txt
+clauses.txt
+config.yml
+conjunctions-coordinating.txt
+conjunctions-subordinate.txt
+nouns-plural.txt
+nouns-singular.txt
+numbers.txt
+prepositions.txt
+terminators.txt
+verbs-passive.txt
+verbs-plural.txt
+verbs-singular.txt
+```
+
+The `terminators.txt` file contains pairs of punctuation,
+separated by commas, one per line. If a sentene terminator
+doesn't have opening punctuation, start the line with a
+comma. More than one character can be used in either side of
+the pair. For example, to create a double quoted sentence
+with a period inside the closing quote, you would use:
+
+    ",."
+
+A blank line (or any line not containing a comma) will
+separate regular punctuation from extended punctuation. In
+the default file, `.`, `?`, and `!` are considered regular
+punctuation, and parenthesis and quotes are considered
+extended punctuation. Extended punctuation is off by
+default, but in the CLI can be enabled with `--extended`,
+and using the library you can include
+`use_extended_punctuation: true` in the options when
+initializing, or use `@rw.use_extended_punctuation = true`
+to set it after initializing.
+
+Repeating words or terminators more than once in the config
+files increases their likelihood of being used. In the
+default terminator.txt files, the period, question mark, and
+exclamation point are repeated multiple times to make them
+the most likely to be used.
+
+
+##### Language Configuration
+
+The `config.yml` file in a language directory is a simple
+YAML configuration. It contains the keys:
+
+```yaml
+---
+name: english
+description: English words
+triggers: [english]
+```
+
+A default configuration file will be created when running `--create-dictionary` with the CLI.
+
+- `name`: The name of the dictionary
+
+    This should be the same as the directory name in most cases
+- `description`: Just used for display when running `--list-dictionaries`
+- `triggers`: An array of triggers that can be used to trigger the language.
+
+    For example, the `bacon` language has the triggers `[bacon, meat, carnivore]`, so you can use `randw -S meat` on the command line (or with the library).
+
+> RandomWords loosely uses English rules for sentence construction, so non-English languages will likely generate even more nonsensical strings.
+
+If you create a fun dictionary, please let me know (or make a PR) and I'll gladly include (most) new dictionaries in the main distribution.
+
+> The easiest way to get words is with AI. A ChatGPT prompt like "give me 100 plural nouns related to the medical profession, in plain text, one per line, sorted alphabetically" will get you a good list of words you can then just paste into `nouns-plural.txt` in your dictionary.
+
 ### Library
 
 ```ruby