docs: update README to v0.1.0 with SVG stack diagram

README.md

@@ -4,27 +4,42 @@ Cross-platform (Windows + macOS) desktop app that connects the **OpenSkyhawk** A
 home cockpit to DCS — replacing the console-only `connect-serial-port.cmd` / `socat`
 relay with a single GUI that **is the bridge and the monitor**.
 
-It auto-detects the SimGateway, relays the DCS-BIOS stream both ways, and shows the
-connection, the loaded aircraft, live stats, a decoded DCS-BIOS log, and full per-element
-HID status. See **[PRD.md](./PRD.md)** for the full design.
+It auto-detects the SimGateway, relays the DCS-BIOS stream both ways, and surfaces
+live connection status, decoded DCS-BIOS log, sim telemetry, full HID status, and
+raw serial monitoring. **v0.1.0** is released with Windows and macOS installers.
 
-> Status: **early scaffold** (Milestone 1). Wiring up over the milestones in the PRD.
+Download: [GitHub Releases](https://github.com/OpenSkyHawk/SkyHawkClient/releases)
 
 ## How it fits the OpenSkyhawk stack
 
-```
-DCS  ──DCS-BIOS (UDP/TCP)──  OpenSkyhawk Client  ──USB CDC serial──  SimGateway ── UART ── PanelBridge ── CAN ── PanelGroups
-                                   │                                   └ HID joystick ─────────────────────────────────┘
-                                   └ reads the HID interface too (axes/buttons/hats)
-```
+![OpenSkyhawk stack diagram](./assets/stack-diagram.svg)
+
+## Source modes
+
+| Mode        | What it does                                                      |
+| ----------- | ----------------------------------------------------------------- |
+| **Bridge**  | SimGateway serial ↔ DCS-BIOS + HID. Full relay, replaces `socat`. |
+| **Monitor** | DCS-BIOS off the LAN, no device. Inspect/test without hardware.   |
+| **Replay**  | Feed a recorded capture into the parser with no DCS running.      |
 
-- **Bridge** mode: SimGateway serial ↔ DCS-BIOS (local, or **remote** DCS via `TCP <host>:7778`).
-- **Monitor** mode: DCS-BIOS off the LAN, no device — inspect/test from any machine.
-- **Replay** mode: feed a recorded capture, no DCS needed.
+## Features
 
-This repo is standalone. Protocol constants (A-4E-C control map, HID layout, `_ACFT_NAME`
-address) are **generated** from a pinned commit of the [OpenSkyhawk firmware
-repo](https://github.com/OpenSkyHawk/OpenSkyhawk) via `npm run sync` — see PRD §7.
+- Auto-detects SimGateway by USB VID/PID (`0x2E8A / 0x4134`) + CDC class
+- Bidirectional DCS-BIOS relay (local multicast, TCP to remote DCS, or unicast)
+- Live decoded DCS-BIOS log — filter, pause, export TSV, raw ↔ named toggle
+- Sim telemetry gauges: RPM, IAS (kt), Flap, Press Alt (ft), Fuel
+- Full HID status: 8 axes, 128 buttons, 4 hat switches
+- Raw serial TX/RX hex monitor (Bridge mode)
+- Record live sessions to `.json`; replay on any machine with no DCS
+- Connected PanelGroup node roster (Bridge mode, firmware flag required)
+- Auto-reconnect on unplug; config persisted to `userData`
+
+## Remote DCS (SimGateway here, DCS on another PC)
+
+DCS-BIOS binds port **7778 on all interfaces** by default. Point the client at
+`tcp://<DCS-IP>:7778` — no script on the DCS host, just open Windows Firewall for
+inbound TCP 7778. The export multicast `239.255.50.10:5010` is loopback-only, so TCP
+is the remote transport. See [PRD §4](./PRD.md) for the full picture.
 
 ## Develop
 
@@ -34,19 +49,19 @@ npm run dev      # launch the app (electron-vite)
 npm test         # vitest unit tests
 npm run lint
 npm run build    # typecheck + bundle
+npm run sync     # regenerate reference files from pinned OpenSkyhawk commit
 ```
 
-## Remote DCS (SimGateway here, DCS on another PC)
+## Sync script
 
-DCS-BIOS binds port **7778 on all interfaces** by default, so the client connects over the
-LAN with **no script on the DCS host** — just open the Windows firewall for inbound TCP 7778
-and point the client at `tcp://<DCS-IP>:7778`. (The export multicast `239.255.50.10:5010` is
-loopback-only, hence TCP is the remote transport.) See PRD §4.
+`scripts/sync-a4ec.ts` (`npm run sync`) sparse-fetches a **pinned OpenSkyhawk commit**
+and regenerates `src/main/reference/*.generated.ts` — the A-4E-C control map, HID layout,
+and SimGateway constants. Generated files are committed so normal builds need no network.
+CI runs a freshness check on every PR.
 
 ## License
 
 Copyright (c) 2026 OpenSkyHawk.
 
-**GPL-2.0-only** — see [LICENSE](./LICENSE) (verbatim GPL v2 text). Matches DCS-BIOS (GPL v2),
-whose control-reference data the client bundles. Note: GPL permits commercial use; it cannot be
-made non-commercial.
+**GPL-2.0-only** — see [LICENSE](./LICENSE). Matches the firmware; Bort (GPL-3) is a
+pattern reference only — no source copied.