readmee: describe program

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0fa44b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# swipeGuess
+
+swipeGuess is a completion program intended to be used as a plugin for touchscreen-keyboards on mobile devices.
+
+For each line input from stdin, it looks through a wordlist and outputs the first possible match for that gesture.
+
+it's run like `input-program | swipeGuess.sh wordlist | output-program`
+
+## input-program
+
+more on this later...
+
+## wordlist
+
+This should be a list of words, sorted by preferability of choice.
+
+Note: you probably want longest words first, otherewise, it may be impossible to type them.
+
+```
+# Good autocompletion for terminal
+ls $PATH | awk '{ print length, $0 }' | sort -nr | cut -d" " -f2- > binsSorted.txt
+
+```
+
+## output-program
+
+* `completelyTypeWord.sh` (included in this repository) will type the characters (besides the first character) using wtype.