From: Scott Worley <scottworley@scottworley.com>
Date: Wed, 11 Oct 2023 02:01:25 +0000 (-0700)
Subject: Describe this project
X-Git-Tag: v0.1.0~1
X-Git-Url: http://git.scottworley.com/tattlekey/commitdiff_plain/5b3e1c6a664981156d3da24bad493e80e282258d?hp=8325ffaa1d5c19fb4e76ee82902c1eddfb5a7462

Describe this project
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9fcc803
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Tattlekey
+
+This is a one-key WiFi UDP 'keyboard'.
+
+The hardware is a Raspberry Pi Pico in a 3d-printed shell connected to
+a Cherry MX switch.
+
+The client software that runs on the device connects to a WiFi network
+and sends UDP packets to an address specified in `client/config.c`.
+It transmits each keypress several times for reliability, with relative
+timestamps so the server can determine the time of every press without
+the device needing to synchronize a clock.
+
+The server software collects and de-duplicates keypress reports.