1 files changed, 38 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..dd80300
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+XIAOMI AIR CONDITIONING C1 ON HOMEBRIDGE
+========================================
+Integrate the Xiaomi AC model `xiaomi.aircondition.ma2`, marketed as the
+Mijia Air Conditioning C1 (1.5 HP, Inverter, Grade 1 Energy Efficiency),
+with Apple Home.
+
+The official product information (in Chinese):
+https://home.mi.com/webapp/content/baike/product/index.html?model=xiaomi.aircondition.ma2
+
+INSTALLATION
+------------
+Install via npm:
+
+    npm install homebridge-xiaomi-aircondition-ma2
+
+USAGE
+-----
+Devices can be added through the Homebridge UI or manually registered in
+`config.json`.
+
+    {
+        "platforms": [
+            {
+                "platform": "XiaomiAirConditionMa2",
+                "devices": [
+                    {
+                        "name": "Living Room AC",
+                        "address": "<DEVICE_IP_ADDRESS>",
+                        "token": "<DEVICE_TOKEN>"
+                    }
+                ]
+            }
+        ]
+    }
+
+AUTHOR
+------
+Zhineng Li <[email protected]>