From 95f9bc2535ca9a28ee97ab7a9a095379a3db61e8 Mon Sep 17 00:00:00 2001 From: Marius Ciotlos Date: Mon, 4 Jun 2018 14:18:31 +0300 Subject: [PATCH] Updated documentation --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index df3910593..f796e946f 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,37 @@ # zigbee2mqtt :bridge_at_night: :honeybee: ![Thumbs up or down?](header.png) + -Allows you to use your Zigbee devices **without** the vendors (Xiaomi/TRADFRI/Hue) bridge/gateway. +Allows you to use your Zigbee devices **without** the vendors (Xiaomi/TRADFRI/Hue) bridge or gateway. -It bridges events and allows you to control your Zigbee devices via MQTT. In this way you can integrate your Zigbee devices with whatever smart home infrastructure you are using. Integrates especially well with [Home Assistant](https://www.home-assistant.io/). - -![Architecture](architecture.png) - -See [Supported devices](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices) to check wether your device is supported. If it's not listed there support can be added (fairly) easy, see [How to support new devices](https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices). +It bridges events and allows you to control your Zigbee devices via MQTT. In this way you can integrate your Zigbee devices with whatever smart home infrastructure you are using. The [wiki](https://github.com/Koenkk/zigbee2mqtt/wiki) provides you all the information needed to get up and running! -### Contributors +## Integrations +Below you will find the most popular home automation integrations available for **zigbee2mqtt**. + + + +### [Home Assistant](https://www.home-assistant.io/) +- [Hassio](https://www.home-assistant.io/hassio/): Using [the official addon](https://github.com/danielwelch/hassio-zigbee2mqtt) from [danielwelch](https://github.com/danielwelch) +- Generic install or Hassbian: Using instructions [here](https://github.com/Koenkk/zigbee2mqtt/wiki/Running-the-bridge#2-installing) + +--- + +## Architecture +![Architecture](architecture.png) + +## Supported devices +See [Supported devices](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices) to check wether your device is supported. There is quite an extensive list including devices from vendors like Xiaomi, Ikea, Philips, OSRAM and more. + +If it's not listed in [Supported devices](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices), support can be added (fairly) easy, see [How to support new devices](https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices). + +## Support & help +If you need assistantce you can check [opened issues](https://github.com/Koenkk/zigbee2mqtt/issues). Feel free to help with Pull Requests when you were able to fix things or add new devices or just share the love on social media. + +## Contributors * [AndrewLinden](https://github.com/AndrewLinden) * [oskarn97](https://github.com/oskarn97) * [dgomes](https://github.com/dgomes)