Updated readme

README.md

@@ -1,72 +1,87 @@
-# Attention: This software is in alpha state !!!
-
 # homebridge-smarthomeng
-Homebridge plugin for SmartHomeNG
+Homebridge plugin for SmartHomeNG. This is work in progress and all devices are supported.
 
 ## Currently supported
-This plugin currently supports:
+This plugin currently supports the following services (and characteristics):
-* LightBulb with on/off and brightness characteristic
+
-* Window Covering with currentposition and targetposition characteristic (state not yet supported)
+* LightBulb (on/off, brightness, hue, saturation)
+* Fan (on/off)
+* Temperature sensor (current temperature)
+* Thermostat (current- / target temperature)
+* Window Covering (current- / target position)
+* Motion sensor (motion detected)
+* Occupancy sensor (motion detected)
 
 ## Requirements
-* SmartHomeNG: https://github.com/smarthomeNG/smarthome
+* [SmartHomeNG](https://github.com/smarthomeNG/smarthome)
-* homebridge: https://www.npmjs.com/package/homebridge
+* [homebridge](https://www.npmjs.com/package/homebridge)
 
 ## Installation
-Install nodejs >= 0.12. You have to find out the right way for your OS. The following commands have been tested on Debian Jessie.
+### Install nodejs >= 0.12.
-<pre>
+You have to find out the right way for your OS. 
-curl -sL https://deb.nodesource.com/setup_4.x | sudo bash -
+
-sudo apt-get install -y nodejs
+
-</pre>
+Debian Jessie:
-Homebridge needs the libavahi-compat-libdnssd-dev lib (installation tested on Debian Jessie)
+
-<pre>
+	curl -sL https://deb.nodesource.com/setup_4.x | sudo bash -
-sudo apt-get install libavahi-compat-libdnssd-dev
+	sudo apt-get install -y nodejs
-</pre>
+
-Install homebridge from NPM repository
+Alpine Linux: (--no-cache example is for building a docker image)
-<pre>
+
-npm install -g homebridge --unsafe-perm
+	apk --no-cache add nodejs
-</pre>
+
+### Install libavahi-compat-libdnssd-dev lib
+Debian Jessie:
+
+	sudo apt-get install libavahi-compat-libdnssd-dev
+
+Alpine Linux: (--no-cache example is for building a docker image)
+
+	apk --no-cache add dbus nodejs avahi avahi-compat-libdns_sd avahi-dev
+
+### Install homebridge from NPM repository
+
+	npm install -g homebridge --unsafe-perm
+
+
+### Install this plugin from NPM repository
+
+	npm install -g homebridge-smarthomeng --unsafe-perm
 
-Install this plugin from NPM repository
-<pre>
-npm install -g homebridge-smarthomeng --unsafe-perm
-</pre>
 
 ## Configuration
-You have to create a config.json in .homebridge directory. You'll find that directory in your home folder.
+You have to create a config.json in .homebridge directory. You'll find that directory in your home folder. This is an example config file which just uses this plugin and some example SmartHomeNG items.
-This is an example config file which just uses this plugin and some example SmartHomeNG items.
-<pre>
-{
-    "bridge": {
-        "name": "HomebridgeSH",
-        "username": "CC:22:3D:E3:CE:32",
-        "port": 51826,
-        "pin": "031-45-154"
-    },
 
-    "platforms": [
+	{
-        {
+	    "bridge": {
-            "platform": "SmartHomeNG",
+	        "name": "HomebridgeSH",
+	        "username": "CC:22:3D:E3:CE:32",
+	        "port": 51826,
+	        "pin": "031-45-154"
+	    },
 	
-            "name": "SmartHomeNG",
+	    "platforms": [
-            "host": "myshngserver.mydomain",
+	        {
-            "accessories": [
+	            "platform": "SmartHomeNG",
-                {
+	             
-                    "name": "Licht Büro",
+	            "name": "SmartHomeNG",
-                    "type": "Lightbulb",
+	            "host": "myshngserver.mydomain",
-                    "onoff": "EG.Buero.Licht"
+	            "accessories": [
-                },
+	                {
-                {
+	                    "name": "Licht Büro",
-                    "name": "Rolladen Büro",
+	                    "type": "Lightbulb",
-                    "type": "WindowCovering",
+	                    "onoff": "EG.Buero.Licht"
-                    "updown": "EG.Buero.Rolladen.AufAb",
+	                },
-                    "currentposition": "EG.Buero.Rolladen.Position",
+	                {
-                    "targetposition": "EG.Buero.Rolladen.Position",
+	                    "name": "Rolladen Büro",
-                    "inverted": true
+	                    "type": "WindowCovering",
-                }
+	                    "updown": "EG.Buero.Rolladen.AufAb",
-            ]
+	                    "currentposition": "EG.Buero.Rolladen.Position",
-        }
+	                    "targetposition": "EG.Buero.Rolladen.Position",
-    ],
+	                    "inverted": true
-    "description": "This is my development config file."
+	                }
-}
+	            ]
-</pre>
+	        }
+	    ],
+	    "description": "This is my development config file."
+	}