diff --git a/README.md b/README.md index 8efa074..12efc7d 100644 --- a/README.md +++ b/README.md @@ -20,16 +20,20 @@ Commands The following commands are exposed by this plugin: >`worddle [join]` +> >> Start a new Worddle game (with no arguments). Use "worddle join" >> to join a game that someone else has started. >`wordshrink [difficulty]` +> >> Start a new WordShrink game. Difficulty values: [easy] medium hard evil >`wordtwist [difficulty]` +> >> Start a new WordTwist game. Difficulty values: [easy] medium hard evil >`wordquit` +> >> Shut down any currently running game. One solution will be displayed for >> the word chain games, to satisfy your curiosity. @@ -100,11 +104,13 @@ Configuration Variables ----------------------- > `plugins.Wordgames.wordFile` +> >> Path to the dictionary file. >> >> Default: `/usr/share/dict/american-english` > `plugins.Wordgames.wordRegexp` +> >> A regular expression defining what a valid word looks like. This will >> be used to filter words from the dictionary file that contain undesirable >> characters (proper names, hyphens, accents, etc.). You will probably have @@ -117,12 +123,14 @@ Configuration Variables >> Default: `^[a-z]+$` > `plugins.Wordgames.worddleDelay` +> >> The length (in seconds) of the pre-game period where players can join a >> new Worddle game. >> >> Default: `15` > `plugins.Wordgames.worddleDuration` +> >> The length (in seconds) of the active period of a Worddle game, when >> players can submit guesses. >>