Initial commit

1 files changed, 36 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..ce9509068bfc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+Python control for Broadlink RM2 IR controllers
+===============================================
+
+A simple Python API for controlling IR controllers from [Broadlink](http://www.ibroadlink.com/rm/). At present, only RM Pro (referred to as RM2 in the codebase) devices are supported and only one device per network will be used. There is currently no support for the cloud API.
+
+Example use
+-----------
+
+Discover an available device on the local network:
+```
+import broadlink
+
+device = broadlink.rm2()
+device.discover()
+```
+
+Obtain the authentication key required for further communication:
+```
+device.auth()
+```
+
+Enter learning mode:
+```
+device.enter_learning()
+```
+
+Obtain an IR packet while in learning mode:
+```
+ir_packet = device.check_data()
+```
+(This will return None if the device does not have a packet to return)
+
+Send an IR packet:
+```
+device.send_data(ir_packet)
+```