Skip to content

Commit ed908fc

Browse files
authored
Merge pull request #748 from rcarteraz/master
update README
2 parents faa8064 + 3710e6e commit ed908fc

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

.github/meshtastic_logo.png

105 KB
Loading

README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Meshtastic Python
1+
<div align="center" markdown="1">
2+
3+
<img src=".github/meshtastic_logo.png" alt="Meshtastic Logo" width="80"/>
4+
5+
<h1 align="center"> Meshtastic Python
6+
</h1>
7+
<p style="font-size:15px;" align="center">A Python library and client for use with Meshtastic devices. </p>
28

39
[![codecov](https://codecov.io/gh/meshtastic/python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/python)
410
![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic)
@@ -7,17 +13,20 @@
713
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
814
![GPL-3.0](https://img.shields.io/badge/License-GPL%20v3-blue.svg)
915

16+
</div>
17+
18+
<div align="center">
19+
<a href="https://meshtastic.org/docs/software/python/cli/installation">Getting Started Guide</a>
20+
-
21+
<a href="https://python.meshtastic.org">API Documentation</a>
22+
</div>
23+
1024
## Overview
1125

12-
A Python client for use with Meshtastic devices.
1326
This small library (and example application) provides an easy API for sending and receiving messages over mesh radios.
1427
It also provides access to any of the operations/data available in the device user interface or the Android application.
1528
Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
1629

17-
**[Getting Started Guide](https://meshtastic.org/docs/software/python/cli/installation)**
18-
19-
**[API Documentation](https://python.meshtastic.org)**
20-
2130
## Call for Contributors
2231

2332
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.

0 commit comments

Comments
 (0)