From 090ab7e5595d03385bb1fa921b7ac01b9969879f Mon Sep 17 00:00:00 2001 From: "Jan-Peter v. Hunnius" Date: Fri, 5 Jun 2026 16:12:34 +0200 Subject: [PATCH] docs: add Web Client section to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 078d9c2..b16a01c 100644 --- a/README.md +++ b/README.md @@ -255,6 +255,19 @@ All fields are optional. } ``` + +## Web Client + +A companion web application ([Racecraft](https://codeberg.org/jhunnius/racecraft)) provides a browser-based interface for live telemetry, session management, and data analysis visualization. It connects to the REST API and renders shift point charts, track maps, and real-time gauges. + +To use with the web client, start the API on all interfaces: + +```bash +RUSTY_TELEMETRY_API_HOST=0.0.0.0 cargo run --release +``` + +Then start the web client on the same machine — it proxies `/api/*` to `localhost:8080` automatically. Access from any machine on the LAN via the Vite dev server's network URL. + ## Testing ```bash