diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4abf47f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# node-red-contrib-xiaomi-devices
+
+This module contains the following nodes to provide easy integration of the Xiaomi devices into node-red.
+
+The following devices are currently supported:
+
+* Temperature/humidity sensor
+* Magnet switch
+* Button switch
+* Motion sensor
+* Power plug (zigbee)
+
+## Preperation
+To receive the gateway json messages on your network you need to enable the developer mode, aka LAN mode in the gateway.
+
+A UDP input node is needed to receive the json messages. An UDP output node to send command's to the gateway.
+
+
+## Install
+
+```
+cd ~\.node-red
+npm install node-red-contrib-xiaomi-devices
+```
+
+## Usage
+
+Below a screenshot of an example use of all nodes.
+
diff --git a/node-red-contrib-xiaomi-ht/xiaomi-ht.html b/node-red-contrib-xiaomi-ht/xiaomi-ht.html
index 903b1ed..7f2e563 100644
--- a/node-red-contrib-xiaomi-ht/xiaomi-ht.html
+++ b/node-red-contrib-xiaomi-ht/xiaomi-ht.html
@@ -94,28 +94,49 @@
-
diff --git a/package.json b/package.json
index a4ca203..a837ad6 100644
--- a/package.json
+++ b/package.json
@@ -1,22 +1,16 @@
{
- "name": "node-red",
+ "name": "node-red-contrib-xiaomi-devices",
"version": "1.0.0",
- "description": "",
- "main": "index.js",
- "scripts": {
- "test": "echo \"Error: no test specified\" && exit 1"
- },
+ "description": "A set of nodes to control some of the popular Xiaomi sensors which are connected to the Xiaomi Gateway.",
"repository": {
"type": "git",
"url": "git+ssh://git@gitlab.com/h-rietman/xiaomi-devices-node-red.git"
},
- "keywords": [],
- "author": "Harald Rietman (http://blog.example.com)",
- "license": "ISC",
+ "keywords": [Xiaomi],
+ "author": "Harald Rietman ",
"bugs": {
"url": "https://gitlab.com/h-rietman/xiaomi-devices-node-red/issues"
},
- "homepage": "https://gitlab.com/h-rietman/xiaomi-devices-node-red#README",
"dependencies": {
"cryptojs": "^2.5.3",
"mustache": "^2.3.0"
diff --git a/xiaomi-devices-overview.png b/xiaomi-devices-overview.png
new file mode 100644
index 0000000..2c5c952
Binary files /dev/null and b/xiaomi-devices-overview.png differ