📚 Add configuration example to docs

hassio-addons · Sep 14, 2018 · 8804648 · 8804648
1 parent 1bb9a54
commit 8804648
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,26 @@ are [compatible][nut-compatible].
 The Network UPS Tools (NUT) project is the combined effort of
 many [individuals and companies][nut-acknowledgements].
 
+Be sure to add a NUT Sensor to your `configuration.yaml` after starting the
+add-on:
+
+```yaml
+sensor:
+  - platform: nut
+    name: "CyberPower 1500"
+    host: a0d7b954-nut
+    username: nutty
+    password: changeme
+    resources:
+      - battery.charge
+      - battery.runtime
+      - ups.load
+      - ups.status
+```
+
+For more information on how to configure the NUT Sensor in Home Assistant
+see the [NUT Sensor documentation][nut-sensor-docs].
+
 ## Installation
 
 The installation of this add-on is pretty straightforward and not different in

diff --git a/nut/.README.j2 b/nut/.README.j2
@@ -24,6 +24,26 @@ are [compatible][nut-compatible].
 The Network UPS Tools (NUT) project is the combined effort of
 many [individuals and companies][nut-acknowledgements].
 
+Be sure to add a NUT Sensor to your `configuration.yaml` after starting the
+add-on:
+
+```yaml
+sensor:
+  - platform: nut
+    name: "CyberPower 1500"
+    host: a0d7b954-nut
+    username: nutty
+    password: changeme
+    resources:
+      - battery.charge
+      - battery.runtime
+      - ups.load
+      - ups.status
+```
+
+For more information on how to configure the NUT Sensor in Home Assistant
+see the [NUT Sensor documentation][nut-sensor-docs].
+
 [Click here for the full documentation][docs]
 
 {% if channel == "edge" %}