summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 7 insertions, 1 deletions
diff --git a/README b/README
index 7beedac..d8e4a6a 100644
--- a/README
+++ b/README
@@ -5,7 +5,8 @@ license is available at https://github.com/dwyl/english-words.
To use codeword, run it with a text file containing a list of words and a
series of arguments that define whether each character position is a missing
-letter (using period), a numbered letter or a fixed letter.
+letter (using period), a numbered letter or a fixed letter. Also optionally
+give it a switch to put it in anagram mode.
For instance:
@@ -19,3 +20,8 @@ second and fourth character position.
To search for a four letter where the third character is 'w' and all other
characters can be any letter.
+
+ codeword -a words_alpha.txt k i w i
+
+To search for anagrams of 'kiwi'. Note that missing letters can also be used
+in this mode. Putting in numbers will raise an error.