From 8a143ce77f1e98c4866825d127113bb0471e6d12 Mon Sep 17 00:00:00 2001
From: monster1025 <admin@yandex5.ru>
Date: Fri, 13 Jan 2017 08:56:37 +0300
Subject: [PATCH] Create README.md

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..06f09c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# aqara-mqtt
+Aqara (Xiaomi) Gateway to MQTT brodge. 
+I use it for home assistant integration and it works well now (exclude Brightness+RGB value of gateway - you need to send it in xiaomi format).
+
+Bridge accept following MQTT set:
+"home/plug/heater/status/set" -> on will turn on plug/heater
+and translate devices state from gateway:
+"home/plug/heater/status" on
+
+Sample config file (config.yaml):
+```
+mqtt:
+  server: 192.168.1.2
+  port: 1883
+  username: username
+  password: passw0rd
+  prefix: home
+
+gateway:
+  password: passw0rd
+
+sids:
+  # motion
+  158d0000e7c7ad:
+    model: motion
+    name: hall
+
+  # temperature
+  158d0001149b3c: 
+    model: sensor_ht
+    name: living
+
+  # plugs
+  158d00010dd98d: 
+    model: plug
+    name: heater
+
+  # buttons
+  158d00012d5720: 
+    model: switch
+    name: kitchen
+
+  # cube
+  158d00011065e3: 
+    model: cube
+    name: main
+
+  # gateway
+  f0b429aa1463: 
+    model: gateway
+    name: main
+```