Update readme

This commit is contained in:
Max Winterstein
2021-02-27 01:02:00 +01:00
parent e76b9908d5
commit ae064078c8
5 changed files with 61 additions and 34 deletions

View File

@@ -1,5 +1,7 @@
# Home Assistant Add-On repository (by Max Winterstein) # Home Assistant Add-On repository (by Max Winterstein)
<a href="https://www.buymeacoffee.com/MaxWinterstein" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
*Everything here is ment to be **experimental**. Happy to see feedback!* *Everything here is ment to be **experimental**. Happy to see feedback!*
Home Assistant Addon repository containing Home Assistant Addon repository containing

View File

@@ -1,22 +1,32 @@
--- ### 🚨 Important Information 🚨
# 🚨 !!Important Update Notice!! 🚨 * This addon recently switched to pre-build images. The Update progress might fail when the installed version is <1.10.0.
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.
Copy your *Configuration* to your clipboard and Uninstall/Install manually. * This is some experimental release!
--- ---
# Home Assistant Add-on: Eufy Home Assistant MQTT Bridge # Home Assistant Add-on: Eufy Home Assistant MQTT Bridge
## Based on https://github.com/matijse/eufy-ha-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.
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. 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! 🚨 🚨 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]
<a href="https://www.buymeacoffee.com/MaxWinterstein" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
## ♥ ## ♥
- [@matijse](https://github.com/matijse/) for coding this awesome bridge - [@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 - [@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

View File

@@ -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. * 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. 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! * I do not guarantee that your ioBroker configuration will not get deleted! This is some experimental release!

View File

@@ -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
```

View File

@@ -1,27 +1,24 @@
--- ### 🚨 Important Information 🚨
# 🚨 !!Important Update Notice!! 🚨 * This addon recently switched to pre-build images. The Update progress might fail when the installed version is <1.4.0.
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.
Copy your *Configuration* to your clipboard and Uninstall/Install manually. * This is some experimental release!
--- ---
# Home Assistant Add-on: TooGoodToGo Home Assistant MQTT Bridge # Home Assistant Add-on: TooGoodToGo Home Assistant MQTT Bridge
## Based on https://github.com/MaxWinterstein/toogoodtogo-ha-mqtt-bridge
--- ![Supports aarch64 Architecture][aarch64-shield]
### 🚨 This is some experimental release! 🚨 ![Supports amd64 Architecture][amd64-shield]
--- ![Supports armv7 Architecture][armv7-shield]
![Supports armhf Architecture][armhf-shield]
![Supports i386 Architecture][i386-shield]
Example Config: <a href="https://www.buymeacoffee.com/MaxWinterstein" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
```toml
mqtt: Based on https://github.com/MaxWinterstein/toogoodtogo-ha-mqtt-bridge
host: homeassistant
port: 1883
username: mqtt [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
password: mqtt [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
tgtg: [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
email: me@example.ocm [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
password: iliketurtles [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
every_n_minutes: 10
timezone: Europe/Berlin
locale: en_us
```