diff --git a/README.md b/README.md index 6a6fe3e..1be44b6 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -[![](https://travis-ci.org/tuanpmt/espmqtt.svg?branch=master)](https://travis-ci.org/tuanpmt/espmqtt) -[![](http://hits.dwyl.io/tuanpmt/espmqtt.svg)](http://hits.dwyl.io/tuanpmt/espmqtt) -[![Twitter Follow](https://img.shields.io/twitter/follow/tuanpmt.svg?style=social&label=Follow)](https://twitter.com/tuanpmt) -![GitHub contributors](https://img.shields.io/github/contributors/tuanpmt/espmqtt.svg) - # ESP32 MQTT Library +![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/espressif/esp-mqtt/test-examples.yml?branch=master) +![License](https://img.shields.io/github/license/espressif/esp-mqtt) +![GitHub contributors](https://img.shields.io/github/contributors/espressif/esp-mqtt) + ## Features -- Based on: https://github.com/tuanpmt/esp_mqtt +- Based on: - Support MQTT over TCP, SSL with mbedtls, MQTT over Websocket, MQTT over Websocket Secure -- Easy to setup with URI +- Easy to setup with URI - Multiple instances (Multiple clients in one application) - Support subscribing, publishing, authentication, will messages, keep alive pings and all 3 QoS levels (it should be a fully functional client). +- Support for MQTT 3.1.1 and 5.0 ## How to use @@ -20,9 +20,9 @@ Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf) ## Documentation -* Please refer to the standard [ESP-IDF](https://github.com/espressif/esp-idf), documentation for the latest version: https://docs.espressif.com/projects/esp-idf/ +- Please refer to the standard [ESP-IDF](https://github.com/espressif/esp-idf), documentation for the latest version: -* Documentation of ESP-MQTT API: https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mqtt.html +- Documentation of ESP-MQTT API: ## License @@ -33,7 +33,9 @@ Apache License ## Older IDF verisons For [ESP-IDF](https://github.com/espressif/esp-idf) versions prior to IDFv3.2, please clone as a component of [ESP-IDF](https://github.com/espressif/esp-idf): + ``` git submodule add https://github.com/espressif/esp-mqtt.git components/espmqtt ``` + and checkout the [ESP-MQTT_FOR_IDF_3.1](https://github.com/espressif/esp-mqtt/tree/ESP-MQTT_FOR_IDF_3.1) tag