Browse Source

chore: add new widgets to readme

pull/901/head
Dan Ditomaso 8 months ago
parent
commit
8b599118f0
  1. 39
      README.md

39
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 interface and its supporting JavaScript libraries. It aims to provide a unified
development experience for interacting with Meshtastic devices. development experience for interacting with Meshtastic devices.
> [!NOTE]
> You can find the main Meshtastic documentation, including installation guides, at https://web.app/.
### Projects within this Monorepo (`packages/`) ### Projects within this Monorepo (`packages/`)
All projects are located within the `packages/` directory: 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 | | 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 [issues tracker](https://github.com/meshtastic/web/issues). Your feedback helps
improve the stability of future releases improve the stability of future releases
### Contributing ## Star history
We welcome contributions! Here’s how the deployment flow works for pull
requests:
- **Preview Deployments:**\
Every pull request automatically generates a preview deployment on Vercel.
This allows you and reviewers to easily preview changes before merging.
- **Staging Environment (`client-test`):**\ <a href="https://star-history.com/#meshtastic/web&Date">
Once your PR is merged, your changes will be available on our staging site: <picture>
[client-test.meshtastic.org](https://client-test.meshtastic.org/).\ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=meshtastic/web&type=Date&theme=dark" />
This environment supports rapid feature iteration and testing without <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=meshtastic/web&type=Date" />
impacting the production site. <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=meshtastic/web&type=Date" width="100%" />
</picture>
</a>
- **Production Releases:**\ ## Contributors
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 <a href="https://github.com/alextran1502/meshtastic/graphs/contributors">
[Contribution Guidelines](https://github.com/meshtastic/web/blob/main/CONTRIBUTING.md) <img src="https://contrib.rocks/image?repo=meshtastic/web" width="100%"/>
before submitting a pull request. We appreciate your help in making the project </a>
better!

Loading…
Cancel
Save