Add README.md

Fosten · Jun 16, 2024 · ead6dfe · ead6dfe
1 parent 71d8c15
commit ead6dfe
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# volto-home-assistant
+Volto add-on to pull data from the Home Assistant API
+
+## Install via package.json
+```shell
+"addons": [
+    "@Fosten/volto-home-assistant"
+],
+"dependencies": {
+    "@Fosten/volto-home-assistant": "Fosten/volto-home-assistant"
+}
+```
+
+## Create a .env file in the project root
+
+```shell
+RAZZLE_HOMEASSISTANT_API_HOST=https://url
+RAZZLE_HOMEASSISTANT_API_PORT=port
+RAZZLE_HOMEASSISTANT_ACCESS_TOKEN=token
+```