From c9464d259561ad5161390ff941b69dc12624d96a Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Thu, 12 May 2022 21:28:38 +1000 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bd0087b..4055545 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,25 @@ -# Meshtastic-python +# Meshtastic Python -[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-python) -![Unit Tests](https://github.com/meshtastic/Meshtastic-python/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/meshtastic/Meshtastic-python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/Meshtastic-python) ![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic) +[![CI](https://img.shields.io/github/workflow/status/meshtastic/Meshtastic-python/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/Meshtastic-python/actions/workflows/ci.yml) [![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/Meshtastic-python)](https://cla-assistant.io/meshtastic/Meshtastic-python) +[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/) +[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss) -A python client for using [Meshtastic](https://www.meshtastic.org) devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in. +## Overview -Full documentation including examples [here](https://meshtastic.org/docs/software/python/python-installation). - -The library api is documented [here](https://meshtastic-python.vercel.app/meshtastic/index.html) +A Python client for use with Meshtastic devices. +This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. +It also provides access to any of the operations/data available in the device user interface or the Android application. +Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in. -[![Powered by Vercel](https://raw.githubusercontent.com/abumalick/powered-by-vercel/master/powered-by-vercel.svg)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss) +**[Getting Started Guide](https://meshtastic.org/docs/software/python/python-installation)** + +**[Documentation/API Reference](https://meshtastic-python.vercel.app/meshtastic/index.html)** + + +## Stats + +![Alt](https://repobeats.axiom.co/api/embed/3d64492daee3a603497071b45e6cdb81d9b2d421.svg "Repobeats analytics image")