Readme rewritten

This commit is contained in:
hsaturn
2021-03-21 12:08:12 +01:00
parent 17fabeae79
commit dd44a4a658

View File

@@ -1,5 +1,12 @@
# TinyMqtt
ESP 8266 is a very capable and small Mqtt Broker and Client
[![GitHub All Releases](https://img.shields.io/github/downloads/hsaturn/TinyMqtt/total)][releases]
![ESP](https://img.shields.io/badge/paltform-ESP8266-green)
![Licence](https://img.shields.io/badge/License-GPL%203.0-green)
![Broker](https://img.shields.io/badge/Mqtt-Broker%203.1.1-green)
![Broker](https://img.shields.io/badge/Mqtt-Client%203.1.1-green)
ESP 8266 is a small and very capable Mqtt Broker and Client
## Features
@@ -13,9 +20,9 @@ ESP 8266 is a very capable and small Mqtt Broker and Client
## Quickstart
- install Streaming library
- install TinyMqtt library
- modify <TinyMqtt/src/my_credentials.h> (wifi setup)
* install [Streaming library](https://github.com/janelia-arduino/Streaming)
* install [TinyMqtt library](https://github.com/hsaturn/TinyMqtt)
* modify <libraries/TinyMqtt/src/my_credentials.h> (wifi setup)
## Examples