Merge pull request #3 from ChrisRomp/docs

Docs
ChrisRomp · Aug 6, 2023 · c043b65 · c043b65
2 parents ae8991e + 86d297f
commit c043b65
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 2 deletions.
diff --git a/ecowitt-proxy/CHANGELOG.md b/ecowitt-proxy/CHANGELOG.md
@@ -0,0 +1,13 @@
+<!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
+# Ecowitt Proxy Add-On
+Changelog
+
+## 0.1.15
+
+- Add minimum documentation
+- Add changelog
+
+
+## 0.1.14
+
+- Initial GitHub release
diff --git a/ecowitt-proxy/DOCS.md b/ecowitt-proxy/DOCS.md
@@ -0,0 +1,7 @@
+# Home Assistant Add-on: Ecowitt Proxy
+
+## How to Use
+
+In your Ecowitt gateway, configure as you would for the [Home Assistant Ecowitt Integration](https://www.home-assistant.io/integrations/ecowitt/), substuting the `Path` option with `/log/ha` only. Do not include your webhook ID here; it will be added to the path automatically by the add-on.
+
+![Example Screenshot](./images/ecowitt_configuration.png)
diff --git a/ecowitt-proxy/Dockerfile b/ecowitt-proxy/Dockerfile
@@ -13,7 +13,7 @@ EXPOSE 8081
 
 # [email protected]
 LABEL \
-  io.hass.version="0.1.14" \
+  io.hass.version="0.1.15" \
   io.hass.type="addon" \
   io.hass.arch="armhf|aarch64|i386|amd64|armv7"
 

diff --git a/ecowitt-proxy/config.yaml b/ecowitt-proxy/config.yaml
@@ -1,6 +1,6 @@
 name: "Ecowitt HTTP Proxy"
 description: "An HTTP proxy for Ecowitt weather stations to foward to the Ecowitt integration over HTTPS since Ecowitt does not support HTTPS"
-version: "0.1.14"
+version: "0.1.15"
 slug: ecowitt-proxy
 homeassistant_api: true
 init: false

diff --git a/ecowitt-proxy/images/ecowitt_configuration.png b/ecowitt-proxy/images/ecowitt_configuration.png