diff --git a/README.md b/README.md index ecdad238f..6d7ed53fc 100644 --- a/README.md +++ b/README.md @@ -1 +1,10 @@ -# Collection of protocol components for ESP-IDF \ No newline at end of file +# Collection of protocol components for ESP-IDF + +[Documentation of esp-protocol](https://espressif.github.io/esp-protocols) + +## Components + +### esp_modem + +* Brief introduction [README](components/esp_modem/README.md) +* Full html [documentation](https://espressif.github.io/esp-protocols/esp_modem/index.html) diff --git a/components/esp_modem/README.md b/components/esp_modem/README.md index 8e6994a43..275ef71b0 100644 --- a/components/esp_modem/README.md +++ b/components/esp_modem/README.md @@ -16,4 +16,4 @@ Get started with one of the examples: ## Documentation * Continue with esp-modem [brief overview](docs/README.md) -* View the full [html documentation ](docs/html/index.html) \ No newline at end of file +* View the full [html documentation](https://espressif.github.io/esp-protocols/esp_modem/index.html)