README: update v0.3.0

1 files changed, 15 insertions, 6 deletions

diff --git a/README.md b/README.md
index 81f37ee..5ed1631 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ For each line input from stdin, it looks through a wordlist and outputs the firs
 
 it's run like `input-program | swipeGuess wordlist.txt | output-program`
 
+swipeGuess also provides options for returning multiple results and ignoring certain characters. See [the man page](https://git.sr.ht/~earboxer/swipeGuess/tree/master/item/swipeGuess.1.scd) for more information.
+
 ## input-program
 
 The input program should output a stream of letters "swiped through", then a newline.
@@ -25,6 +27,7 @@ Good starting points can be found on the web, based on your language.
 * https://raw.githubusercontent.com/dwyl/english-words/master/words.txt - 466,550 words, including many proper nouns like names.
 * https://norvig.com/ngrams/count_1w.txt - 333,333 words, abbreviations, etc, sorted by popularity.
 * https://www.keithv.com/software/wlist/index.php - page with several links providing intersections between english word lists (26,680 - 1,516,998 words)
+* Your computer may have a list installed already in /usr/share/dict/, or one may be installable through your package manager.
 
 ### sorting tips
 
@@ -36,16 +39,18 @@ ls $PATH | awk '{ print length, $0 }' | sort -nr | cut -d" " -f2- > binsSorted.t
 
 ```
 
-Smarter sorting would be keyboard-layout aware. mapscore.py can do that for you
+Smarter sorting would be keyboard-layout aware. mapScore can do that for you
 
 ```sh
-./mapScore.py map.tsv <words.txt | sort -nr | cut -f2 > wordsSorted.txt
+./mapScore map.tsv <words.txt | sort -nr | cut -f2 > wordsSorted.txt
 ```
 
-map.tsv uses tabs and newlines to create the grid-based layout. See `map.qwerty.simplegrid.tsv` for a sample of how to format this file.
+map.tsv uses tabs and newlines to create the grid-based layout. See `map.qwerty.noapos.tsv` for a sample of how to format this file.
 
 If your keys are in a hexagonal layout, use mapScore like
-`./mapScore.py map.simple.tsv bee`.
+`./mapScore map.simple.tsv bee`.
+
+(`mapScore.py` was the old version of this, and probably should be removed, being slower and with less features.).
 
 ## output-program
 
@@ -53,8 +58,12 @@ If your keys are in a hexagonal layout, use mapScore like
 
 # Installation/Usage with wvkbd
 
-1. Be using a wayland-based graphical shell (such as sway)
+1. Be using a wayland-based graphical shell (such as sway), and have wtype installed.
 2. Compile with your favorite C compiler: `gcc swipeGuess.c -o swipeGuess`.
-2. copy swipeGuess completelyTypeWord.sh into your $PATH (`~/.local/bin/` or `/usr/local/bin/` for example)
+2. copy swipeGuess and completelyTypeWord.sh into your $PATH (`~/.local/bin/` or `/usr/local/bin/` for example)
 3. `wvkbd-mobintl -O | swipeGuess /path/to/words.txt | completelyTypeWord.sh`
 	* In SXMO, `KEYBOARD_ARGS='-O | swipeGuess /path/to/words.txt | completelyTypeWord.sh'` can be added to your ~/.profile to enable this (effective on restart).
+
+# Extended information
+
+[SwipeBehaviors](https://git.sr.ht/~earboxer/SwipeBehaviors) is a project that uses swipeGuess and provides more advanced functionality, like presenting several choices that can be picked with [suggpicker](https://git.sr.ht/~earboxer/suggpicker).