From c3f073a38069dae546420b6cdaed9e77bd732157 Mon Sep 17 00:00:00 2001 From: Dan Ditomaso Date: Tue, 21 Oct 2025 14:31:28 -0400 Subject: [PATCH] Update readme with new widgets (#901) * chore: add new widgets to readme * add docs url * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 39 ++++++++++++++++----------------------- 1 file changed, 16 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 654c216f..75b989aa 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ This monorepo consolidates the official [Meshtastic](https://meshtastic.org) web interface and its supporting JavaScript libraries. It aims to provide a unified development experience for interacting with Meshtastic devices. +> [!NOTE] +> You can find the main Meshtastic documentation at https://meshtastic.org/docs/introduction/. + ### Projects within this Monorepo (`packages/`) All projects are located within the `packages/` directory: @@ -33,7 +36,7 @@ All `Meshtastic JS` packages (core and transports) are published both to --- -## Stats +## Repository activity | Project | Repobeats | | :------------- | :-------------------------------------------------------------------------------------------------------------------- | @@ -87,28 +90,18 @@ If you encounter any issues, please report them in our [issues tracker](https://github.com/meshtastic/web/issues). Your feedback helps improve the stability of future releases -### Contributing +## Star history -We welcome contributions! Here’s how the deployment flow works for pull -requests: + + + + + Star History Chart + + -- **Preview Deployments:**\ - Every pull request automatically generates a preview deployment on Vercel. - This allows you and reviewers to easily preview changes before merging. +## Contributors -- **Staging Environment (`client-test`):**\ - Once your PR is merged, your changes will be available on our staging site: - [client-test.meshtastic.org](https://client-test.meshtastic.org/).\ - This environment supports rapid feature iteration and testing without - impacting the production site. - -- **Production Releases:**\ - At regular intervals, stable and fully tested releases are promoted to our - production site: [client.meshtastic.org](https://client.meshtastic.org/).\ - This is the primary interface used by the public to connect with their - Meshtastic nodes. - -Please review our -[Contribution Guidelines](https://github.com/meshtastic/web/blob/main/CONTRIBUTING.md) -before submitting a pull request. We appreciate your help in making the project -better! + + +