diff --git a/.github/meshtastic_logo.png b/.github/meshtastic_logo.png new file mode 100644 index 00000000..85621093 Binary files /dev/null and b/.github/meshtastic_logo.png differ diff --git a/README.md b/README.md index 6b623bb6..494c5197 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -# Meshtastic Python +
+ +Meshtastic Logo + +

Meshtastic Python +

+

A Python library and client for use with Meshtastic devices.

[![codecov](https://codecov.io/gh/meshtastic/python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/python) ![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic) @@ -7,17 +13,20 @@ [![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/) ![GPL-3.0](https://img.shields.io/badge/License-GPL%20v3-blue.svg) +
+ +
+ Getting Started Guide + - + API Documentation +
+ ## Overview -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. -**[Getting Started Guide](https://meshtastic.org/docs/software/python/cli/installation)** - -**[API Documentation](https://python.meshtastic.org)** - ## Call for Contributors This library and CLI has gone without a consistent maintainer for a while, and there's many improvements that could be made. We're all volunteers here and help is extremely appreciated, whether in implementing your own needs or helping maintain the library and CLI in general.