about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorZach DeCook <zachdecook@librem.one>2021-10-21 17:04:57 -0400
committerZach DeCook <zachdecook@librem.one>2021-10-21 17:04:57 -0400
commitd4fc2356cf7527e8273eb39d90e5a3f80a7e84ae (patch)
tree20cdfe4b391667c1e4c21e0145fc7897d402ddd6 /README.md
parent1a454fd9704391f35f857c3bd12d5eb6747b1a0d (diff)
downloadswipeGuess-d4fc2356cf7527e8273eb39d90e5a3f80a7e84ae.tar.gz
readme: describe input program
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index c939730..cdf4ad6 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,11 @@ it's run like `input-program | swipeGuess.sh wordlist | output-program`
 
 ## input-program
 
-more on this later...
+The input program should output a stream of letters "swiped through", then a newline.
+
+There's a WIP Merge Request towards proycon's wvkbd for an example of this.
+
+=> https://github.com/proycon/wvkbd/pull/1
 
 ## wordlist