Add talkf formatter function

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
index 9043083..582aaa8 100644
--- a/README.md
+++ b/README.md
@@ -31,10 +31,33 @@ $ ./jdtalk
 ## Usage
 
 ```bash
+-f   --format Produce words with formatted string
 -c    --limit (default: 0)
 -p  --pattern Limit output to a root word
 -e    --exact Exact matches only (default: false)
+-s    --salad Produce N random words
+      --rcase Randomize case (default: false)
+      --hcase Change every other case (default: false)
+       --leet 1337ify output (default: false)
 -d --dataroot Path to dictionaries
 -h     --help This help information.
 ```
 
+# Formatters
+
+For use with `--format`
+
+* `%a` - Adjective
+* `%d` - Adverb
+* `%n` - Noun
+* `%v` - Verb
+
+## Example
+
+```bash
+$ jdtalk --fmt "%a%a%n%d%v"
+hexadecimal satiric reconnoitrer ultimately beef
+[...]
+```
+
+This is not a print function, however. `--format "Are you a nice %a %n? Go %v in the mirror."` will produce `hairy mouse runs`, not `Are you a nice hairy mouse? Go run in the mirror."`.