diff --git a/README.md b/README.md index 4d82a1c5..2c518476 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,47 @@ -[![Travis](https://img.shields.io/travis/Koenkk/zigbee2mqtt.svg)](https://api.travis-ci.org/Koenkk/zigbee2mqtt.svg) +
+ + + +
+
+ +

Zigbee2mqtt 🌉 🐝

+

+ Allows you to use your Zigbee devices without the vendors 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. +

+
-# zigbee2mqtt :bridge_at_night: :honeybee: -![Thumbs up or down?](images/header.png) - +## [Getting started](https://koenkk.github.io/zigbee2mqtt/#getting-started) +The [documentation](https://koenkk.github.io/zigbee2mqtt/) provides you all the information needed to get up and running! Make sure you don't skip sections if this is your first visit, as there might be important details in there for you. -Allows you to use your Zigbee devices **without** the vendors (Xiaomi/TRADFRI/Hue) bridge or gateway. +If you aren't familiar with **Zigbee** terminology make sure you [read this](https://koenkk.github.io/zigbee2mqtt/information/zigbee_network.html) to help you out. -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. - -## [Getting started](https://github.com/Koenkk/zigbee2mqtt/wiki/Getting-started) -The [wiki](https://github.com/Koenkk/zigbee2mqtt/wiki) provides you all the information needed to get up and running! Make sure you don't skip sections if this is your first visit, as there might be important details in there for you. - -[The documentation](https://github.com/Koenkk/zigbee2mqtt/wiki) will provide information on how to prepare, configure and start **zigbee2mqtt**, but also on how to customize the setup to fit your needs. - -If you aren't familiar with **zigbee** terminology make sure you [read this](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network) to help you out. - -## Integrations +## [Integrations](https://koenkk.github.io/zigbee2mqtt/#integration) Zigbee2mqtt integrates well with (almost) every home automation solution because it uses MQTT. However the following integrations are worth mentioning: ### [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/Integrating-with-Home-Assistant) +- Generic install or Hassbian: Using instructions [here](https://koenkk.github.io/zigbee2mqtt/integration/home_assistant.html) ### [Domoticz](https://www.domoticz.com/) - Integration implemented in [domoticz-zigbee2mqtt-plugin](https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin) -## Architecture +
+ +## Architecture ![Architecture](images/architecture.png) ## Supported devices -See [Supported devices](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices) to check whether your device is supported. There is quite an extensive list, including devices from vendors like Xiaomi, Ikea, Philips, OSRAM and more. +See [Supported devices](https://koenkk.github.io/zigbee2mqtt/information/supported_devices.html) to check whether 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). +If it's not listed in [Supported devices](https://koenkk.github.io/zigbee2mqtt/information/supported_devices.html), support can be added (fairly) easy, see [How to support new devices](https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html). ## Support & help -If you need assistance 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) -* [Koenkk](https://github.com/Koenkk) -* [kirovilya](https://github.com/kirovilya) -* [ciotlosm](https://github.com/ciotlosm) +If you need assistance 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. diff --git a/images/header.png b/images/header.png deleted file mode 100644 index 0c389f47..00000000 Binary files a/images/header.png and /dev/null differ diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 00000000..b8338a39 Binary files /dev/null and b/images/logo.png differ