From ae064078c81bf98fb289f90bd417abd5db1874c2 Mon Sep 17 00:00:00 2001 From: Max Winterstein Date: Sat, 27 Feb 2021 01:02:00 +0100 Subject: [PATCH] Update readme --- README.md | 2 ++ eufy-ha-mqtt-bridge/README.md | 32 ++++++++++++++-------- ioBroker/README.md | 2 +- toogoodtogo-ha-mqtt-bridge/DOCS.md | 18 ++++++++++++ toogoodtogo-ha-mqtt-bridge/README.md | 41 +++++++++++++--------------- 5 files changed, 61 insertions(+), 34 deletions(-) create mode 100644 toogoodtogo-ha-mqtt-bridge/DOCS.md diff --git a/README.md b/README.md index 05bd58f..38f1323 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Home Assistant Add-On repository (by Max Winterstein) +Buy Me A Coffee + *Everything here is ment to be **experimental**. Happy to see feedback!* Home Assistant Addon repository containing diff --git a/eufy-ha-mqtt-bridge/README.md b/eufy-ha-mqtt-bridge/README.md index d472cab..639053e 100644 --- a/eufy-ha-mqtt-bridge/README.md +++ b/eufy-ha-mqtt-bridge/README.md @@ -1,22 +1,32 @@ ---- -# 🚨 !!Important Update Notice!! 🚨 -This addon recently switched to pre-build images. The Update progress might fail when the installed version is <1.10.0. -Copy your *Configuration* to your clipboard and Uninstall/Install manually. +### 🚨 Important Information 🚨 +* This addon recently switched to pre-build images. The Update progress might fail when the installed version is <1.10.0. + Copy your *Configuration* to your clipboard and Uninstall/Install manually. +* This is some experimental release! --- # Home Assistant Add-on: Eufy Home Assistant MQTT Bridge -## Based on https://github.com/matijse/eufy-ha-mqtt-bridge/ ---- -## 🚨 This is some experimental release! 🚨 ---- - -Quick wrapp around https://github.com/matijse/eufy-ha-mqtt-bridge. +Based on https://github.com/matijse/eufy-ha-mqtt-bridge. Application data will be written to `/share/eufy-ha-mqtt-bridge/` so log and other files can be accessed from other addons, e.g. the `Samba share` addon, or view it at the `Visual Studio Code` add-on. 🚨 This also contains some plaintext configuration file with login credentials, so take care who can access your files! 🚨 +![Supports aarch64 Architecture][aarch64-shield] +![Supports amd64 Architecture][amd64-shield] +![Supports armv7 Architecture][armv7-shield] +![Supports armhf Architecture][armhf-shield] +![Supports i386 Architecture][i386-shield] + +Buy Me A Coffee + + ## ♥ - [@matijse](https://github.com/matijse/) for coding this awesome bridge -- [@davida72](https://github.com/matijse/eufy-ha-mqtt-bridge/issues/1#issuecomment-753333591]) for the awesome icon \ No newline at end of file +- [@davida72](https://github.com/matijse/eufy-ha-mqtt-bridge/issues/1#issuecomment-753333591]) for the awesome icon + +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg diff --git a/ioBroker/README.md b/ioBroker/README.md index f3af939..f6fba9d 100644 --- a/ioBroker/README.md +++ b/ioBroker/README.md @@ -1,5 +1,5 @@ -### 🚨 Important Inforation 🚨 +### 🚨 Important Information 🚨 * This addon recently switched to pre-build images. The Update progress might fail when the installed version is <0.6.0. Copy your *Configuration* to your clipboard and Uninstall/Install manually. * I do not guarantee that your ioBroker configuration will not get deleted! This is some experimental release! diff --git a/toogoodtogo-ha-mqtt-bridge/DOCS.md b/toogoodtogo-ha-mqtt-bridge/DOCS.md new file mode 100644 index 0000000..8e689fc --- /dev/null +++ b/toogoodtogo-ha-mqtt-bridge/DOCS.md @@ -0,0 +1,18 @@ +# Home Assistant Add-on: TooGoodToGo Home Assistant MQTT Bridge + +## Configuration + +Example Config: +```toml +mqtt: + host: homeassistant + port: 1883 + username: mqtt + password: mqtt +tgtg: + email: me@example.ocm + password: iliketurtles + every_n_minutes: 10 +timezone: Europe/Berlin +locale: en_us +``` \ No newline at end of file diff --git a/toogoodtogo-ha-mqtt-bridge/README.md b/toogoodtogo-ha-mqtt-bridge/README.md index 290080b..5752e3f 100644 --- a/toogoodtogo-ha-mqtt-bridge/README.md +++ b/toogoodtogo-ha-mqtt-bridge/README.md @@ -1,27 +1,24 @@ ---- -# 🚨 !!Important Update Notice!! 🚨 -This addon recently switched to pre-build images. The Update progress might fail when the installed version is <1.4.0. -Copy your *Configuration* to your clipboard and Uninstall/Install manually. +### 🚨 Important Information 🚨 +* This addon recently switched to pre-build images. The Update progress might fail when the installed version is <1.4.0. + Copy your *Configuration* to your clipboard and Uninstall/Install manually. +* This is some experimental release! --- # Home Assistant Add-on: TooGoodToGo Home Assistant MQTT Bridge -## Based on https://github.com/MaxWinterstein/toogoodtogo-ha-mqtt-bridge ---- -### 🚨 This is some experimental release! 🚨 ---- +![Supports aarch64 Architecture][aarch64-shield] +![Supports amd64 Architecture][amd64-shield] +![Supports armv7 Architecture][armv7-shield] +![Supports armhf Architecture][armhf-shield] +![Supports i386 Architecture][i386-shield] -Example Config: -```toml -mqtt: - host: homeassistant - port: 1883 - username: mqtt - password: mqtt -tgtg: - email: me@example.ocm - password: iliketurtles - every_n_minutes: 10 -timezone: Europe/Berlin -locale: en_us -``` \ No newline at end of file +Buy Me A Coffee + +Based on https://github.com/MaxWinterstein/toogoodtogo-ha-mqtt-bridge + + +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg