More description. Images

[tattlekey] / README.md

diff --git a/README.md b/README.md
index 9fcc80324cfcc48c7f950c12a90d1f24a46e3a02..4cb16162bd693c034a3a05061ab3339d9d3f92cc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
 
 This is a one-key WiFi UDP 'keyboard'.
 
 
 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 hardware is a Raspberry Pi Pico W in a 3d-printed shell connected
+to a Cherry MX key 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`.
 
 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`.


@@ -11,4 +11,12 @@ 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.
 
 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.
+The server software collects, logs, and de-duplicates keypress reports.
+
+The housing grips the pico by the edges through spring force; you'll need
+to squeeze the housing flat (eg: with a clamp) to deform it slightly to
+allow the pico board to slide in and out easily.  Note that the housing is
+subtly _not symmetrical_: There is a top and a bottom.  Do not force the
+pico board in upside down or you will destroy the board's bootsel button.
+
+![The tattlekey 'keyboard'](docs/tattlekey.jpg)