Update some documentation

Johboh · Dec 25, 2023 · 7d393ec · 7d393ec
1 parent 339836f
commit 7d393ec
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![GitHub release](https://img.shields.io/github/release/Johboh/EspNowNetwork.svg)](https://github.com/Johboh/EspNowNetwork/releases)
 
 
-Arduino and ESP-IDF compatible library for setting up a network of ESP NOW nodes
+Arduino (using Arduino IDE or Platform I/O) and ESP-IDF (using Espressif IoT Development Framework or Platform I/O) compatible library for setting up a network of ESP NOW nodes
 
 ### Usage/Purpose
 The use case for the EspNowNetwork is to run a a [ESP-NOW](https://www.espressif.com/en/solutions/low-power-solutions/esp-now) network for battery powered sensors.
@@ -16,20 +16,20 @@ Features:
 - **Over The Air/OTA**: A node can be updated Over The Air. The node report their firmware version upon handsake, and the host can send back wifi credentials and an URL where to download the new firmware. The node will download the firmware, write it and restart.
 
 ### Installation
-#### Platform I/O:
+#### Platform I/O (Arduino or ESP-IDF):
 Add the following to `libs_deps`:
 ```
    Johboh/EspNowNetwork
 ```
-#### ESP-IDF:
+#### Espressif IoT Development Framework:
 In your existing `idf_component.yml` or in a new `idf_component.yml` next to your main component:
 ```
 dependencies:
-  EspNowNetwork:
-    git: https://github.com/Johboh/EspNowNetwork.git
+  johboh/EspNowNetwork:
+    version: ">=0.4.0"
 ```
 
-### Example
+### Example (Arduino framework)
 See [host example](examples/Host/Host.ino) and [node example](examples/Node/Node.ino).
 
 ### Functionallity verified on the following platforms and frameworks

diff --git a/idf_component.yml b/idf_component.yml
@@ -1,5 +1,5 @@
 version: "0.4.0"
-description: Arduino/ESP-IDF library for setting up a network of ESP NOW nodes
+description: Library for setting up a network of ESP NOW nodes
 url: https://github.com/Johboh/EspNowNetwork
 dependencies:
   idf: ">=4.4"
diff --git a/library.json b/library.json
@@ -1,7 +1,7 @@
 {
   "name": "EspNowNetwork",
   "keywords": "esp32, esp-now, ESP Now, now",
-  "description": "Arduino/ESP-IDF library for setting up a network of ESP NOW nodes",
+  "description": "Library for setting up a network of ESP NOW nodes",
   "$schema": "https://raw.githubusercontent.com/platformio/platformio-core/develop/platformio/assets/schema/library.json",
   "authors":
   {
@@ -19,5 +19,17 @@
   },
   "frameworks": ["espidf", "arduino"],
   "platforms": ["espressif32"],
+  "examples": [
+    {
+      "name": "Host",
+      "base": "examples/host",
+      "files": ["Host.ino"]
+    },
+    {
+      "name": "Node",
+      "base": "examples/Node",
+      "files": ["Node.ino"]
+    }
+  ],
   "dependencies": []
 }
diff --git a/library.properties b/library.properties
@@ -2,8 +2,8 @@ name=EspNowNetwork
 version=0.4.0
 author=Johan Böhlin <[email protected]>
 maintainer=Johan Böhlin <[email protected]>
-sentence=Arduino/ESP-IDF library for setting up a network of ESP NOW nodes
-paragraph=Arduino/ESP-IDF library for setting up a network of ESP NOW nodes
+sentence=Library for setting up a network of ESP NOW nodes
+paragraph=Library for setting up a network of ESP NOW nodes
 category=Communication
 url=https://github.com/Johboh/EspNowNetwork
 architectures=esp32