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

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