docs(esp_mqtt_cxx): updated documentation and deployment file

This commit is contained in:
Suren Gabrielyan
2023-04-04 14:36:52 +04:00
parent db0e20f446
commit a547ec8147
4 changed files with 21 additions and 3 deletions

View File

@ -46,6 +46,6 @@ jobs:
- name: Upload components to component service
uses: espressif/github-actions/upload_components@master
with:
directories: "components/esp_modem;components/esp_websocket_client;components/mdns;components/asio"
directories: "components/esp_modem;components/esp_websocket_client;components/mdns;components/asio;components/esp_mqtt_cxx"
namespace: "espressif"
api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

View File

@ -22,3 +22,8 @@
* Brief introduction [README](components/asio/README.md)
* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/asio/index.html)
### esp_mqtt_cxx
* Brief introduction [README](components/esp_mqtt_cxx/README.md)
* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/esp_mqtt_cxx/index.html)

View File

@ -0,0 +1,13 @@
# esp_mqtt_cxx
[![Component Registry](https://components.espressif.com/components/espressif/esp_mqtt_cxx/badge.svg)](https://components.espressif.com/components/espressif/esp_mqtt_cxx)
The ESP MQTT client is a wrapper over the esp_mqtt client with the goal of providing a higher level API.
## Examples
Get started with [examples](examples)
## Documentation
* View the full [html documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/esp_mqtt_cxx/index.html)

View File

@ -36,8 +36,8 @@ Events are dispatched throug calls to member functions each one dedicated to a t
Application Example
-------------------
* :example:`tcp <../examples/tcp>`
* :example:`ssl <../examples/ssl>`
* :example:`tcp <../../components/esp_mqtt_cxx/examples/tcp>`
* :example:`ssl <../../components/esp_mqtt_cxx/examples/ssl>`
API Reference
-------------