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 +

+ +

-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/l5yth/potato-mesh/ruby.yml?branch=main)](https://github.com/l5yth/potato-mesh/actions) -[![GitHub release](https://img.shields.io/github/v/release/l5yth/potato-mesh)](https://github.com/l5yth/potato-mesh/releases) -[![codecov](https://codecov.io/gh/l5yth/potato-mesh/branch/main/graph/badge.svg?token=FS7252JVZT)](https://codecov.io/gh/l5yth/potato-mesh) -[![Open-Source License](https://img.shields.io/github/license/l5yth/potato-mesh)](LICENSE) -[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/l5yth/potato-mesh/issues) -[![Matrix Chat](https://img.shields.io/badge/matrix-%23potatomesh:dod.ngo-blue)](https://matrix.to/#/#potatomesh:dod.ngo) +

PotatoMesh

-[![Meshtastic](https://img.shields.io/badge/Meshtastic-supported-67ea94)](https://meshtastic.org) -[![Meshcore](https://img.shields.io/badge/Meshcore-supported-1f2937)](https://meshcore.io) -[![Reticulum](https://img.shields.io/badge/Reticulum-experimental-7b61ff)](https://reticulum.network) +

+ A federated Meshtastic, Meshcore, and Reticulum node dashboard for your local community.
+ No MQTT clutter, just local LoRa aether. +

-A federated Meshtastic, Meshcore, and Reticulum node dashboard for your local community. -_No MQTT clutter, just local LoRa aether._ +

+ GitHub Workflow Status + GitHub release + codecov + Open-Source License + Contributions Welcome + Matrix Chat +

+ +

+ Meshtastic + Meshcore + Reticulum +

+ +

+ PotatoMesh 1.0 dashboard: chat log, live node map and nodes table +

+ +

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) - -![screenshot of the sixth version](./scrot-0.7.png) - 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