Merge pull request #2 from smartgic/master

[readme] Update documentation
smartgic · Jan 4, 2024 · 76939a0 · 76939a0
2 parents 82a85d0 + c1b0cbe
commit 76939a0
Showing 1 changed file with 11 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -18,18 +18,24 @@ pip install ovos-phal-plugin-ww-led
 
 The plugin configuration file is `~/.config/OpenVoiceOS/ovos-phal-plugin-ww-led.json`.
 
-| Option          | Value   | Description                                |
-| --------------- | ------- | ------------------------------------------ |
-| `gpio_pin`      | `N/A`   | GPIO PIN where the LED is connected        |
-| `wakeword_only` | `false` | Turn on only during the wakeword detection |
-| `pulse`         | `true`  | Make the LED pulsing                       |
+| Option          | Value   | Description                                        |
+| --------------- | ------- | -------------------------------------------------- |
+| `gpio_pin`      | `N/A`   | GPIO PIN where the LED is connected                |
+| `wakeword_only` | `false` | Turn on the LED only during the wakeword detection |
+| `pulse`         | `true`  | Make the LED pulse                                 |
 
 ### Example
 
+Configuration sample of `~/.config/OpenVoiceOS/ovos-phal-plugin-ww-led.json`.
+
 ```json
 {
   "gpio_pin": 25,
   "wakeword_only": false,
   "pulse": true
 }
 ```
+
+## Credits
+
+- [Smart'Gic](https://smartgic.io/)