diff --git a/README.md b/README.md index 345f785..7212c73 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,29 @@ AI agent. This bridge was built to support https://github.com/k0swe/forester but can be used by any web application that needs to communicate with amateur radio installed programs. -![Architecture](architecture.svg) - -This currently supports communication with WSJT-X. Planned support includes `rigctld` and Ham Radio -Deluxe for transceiver remote control. +```mermaid +flowchart LR + Internet([Internet]) --- Application[Web Application] + subgraph Computer + subgraph Browser[Web Browser] + Application + end + agent[kel-agent] + WSJTX[WSJT-X] + rigctld[rigctl/Hamlib] + HRD[HRD] + etc[...] + end + Application ---|websocket| agent + agent ---|UDP| WSJTX + agent ---|lib| rigctld + agent -.->|UDP| HRD + agent -.-> etc + style agent fill:#8ecfff,stroke:#1f2937,stroke-width:2px +``` + +This currently supports communication with WSJT-X, and now officially supports rig control via +`rigctl`/Hamlib. Ham Radio Deluxe support remains planned. To get started using `kel-agent`, download an appropriate executable from the [latest release](https://github.com/k0swe/kel-agent/releases/latest). Windows, Mac, Debian/Ubuntu