diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ae234f7..45ac5faa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -126,6 +126,7 @@ * Docs: every environment variable the ingestor or web app reads is documented (SPEC DOC2) * Docs/Config: `configure.sh` and the NixOS module are no longer Meshtastic-only (SPEC DOC3) * Docs: the README documents every route (SPEC DOC4) +* Docs: the README opens with the logo, the name, the badges and the 1.0 screenshot, centered (SPEC RH1) * Docs: the dual basemap-CDN egress disclosure was restored (SPEC SB6) * Docs: `CONTRACTS.md` corrected to match the served `/api/destinations` shape (SPEC DOC5) * Docs: `ACCEPTANCE.md` amended for the shipped Reticulum stats scope; README gains a Reticulum section diff --git a/README.md b/README.md index 76e90539..10537ead 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,37 @@ -# 🥔 PotatoMesh +
-[](https://github.com/l5yth/potato-mesh/actions) -[](https://github.com/l5yth/potato-mesh/releases) -[](https://codecov.io/gh/l5yth/potato-mesh) -[](LICENSE) -[](https://github.com/l5yth/potato-mesh/issues) -[](https://matrix.to/#/#potatomesh:dod.ngo) +
+ A federated Meshtastic, Meshcore, and Reticulum node dashboard for your local community.
+ No MQTT clutter, just local LoRa aether.
+
Live demo for Berlin: potatomesh.net
* Web dashboard: map + chat, nodes, positions, neighbors, trace routes, telemetry, messages. * API to `POST` (authenticated) and `GET` nodes, messages, and telemetry. @@ -28,10 +44,6 @@ _No MQTT clutter, just local LoRa aether._ * Supports Meshtastic, Meshcore, and Reticulum (experimental, announce-only). * Matrix bridge posts Meshtastic messages to a Matrix channel (no radio required). -Live demo for Berlin: [potatomesh.net](https://potatomesh.net) - - - Jump to Contents: - [Web App](#web-app) - configuration, running, deploying, monitoring, etc. - [Ingestor](#ingestor) - configuration, running, transmitting, etc. diff --git a/scrot-1.0.png b/scrot-1.0.png new file mode 100644 index 00000000..a94205d8 Binary files /dev/null and b/scrot-1.0.png differ