Update README.md

Author: euphi

README.md

@@ -1,21 +1,21 @@
 ![homie-esp8266 banner](banner.png)
 
+*** THIS IS THE DEVELOPMENT BRANCH FOR Version 3.x.y ***
+- See https://github.com/homieiot/homie-esp8266 for current 2.0.y releases
+ 
 Homie for ESP8266
 =================
 
-[![Build Status](https://img.shields.io/circleci/project/github/homieiot/homie-esp8266/develop.svg?style=flat-square)](https://circleci.com/gh/homieiot/homie-esp8266) [![Latest Release](https://img.shields.io/badge/release-v2.0.0-yellow.svg?style=flat-square)](https://github.com/homieiot/homie-esp8266/releases) [![Gitter](https://img.shields.io/gitter/room/Homie/ESP8266.svg?style=flat-square)](https://gitter.im/homie-iot/ESP8266)
+[![Build Status](https://img.shields.io/circleci/project/github/homieiot/homie-esp8266/develop-v3.svg?style=flat-square)](https://circleci.com/gh/homieiot/homie-esp8266) [![Latest Release](https://img.shields.io/badge/release-v2.0.0-yellow.svg?style=flat-square)](https://github.com/homieiot/homie-esp8266/releases) [![Gitter](https://img.shields.io/gitter/room/Homie/ESP8266.svg?style=flat-square)](https://gitter.im/homie-iot/ESP8266)
 
 An Arduino for ESP8266 implementation of [Homie](https://github.com/homieiot/convention), an MQTT convention for the IoT.
 
-Currently Homie for ESP8266 implements [Homie 3.0.1](https://github.com/homieiot/convention/releases/tag/v3.0.1)
-
-## Note for v1.x users
-
-The old configurator is not available online anymore. You can download it [here](https://github.com/homieiot/homie-esp8266/releases/download/v1.5.0/homie-esp8266-v1-setup.zip).
+This branch of Homie for ESP8266 implements [Homie 3.0.1](https://github.com/homieiot/convention/releases/tag/v3.0.1)
 
 ## Download
 
-The Git repository contains the development version of Homie for ESP8266. Stable releases are available [on the releases page](https://github.com/marvinroger/homie-esp8266/releases).
+The Git repository contains the development version of Homie for ESP8266. Stable releases are available [on the releases page](https://github.com/homieiot/homie-esp8266/releases).
+Note that there is no release of the 3.x.y branch yet. Please use the git repository if you are interested in latest development.
 
 ## Using with PlatformIO
 
@@ -43,6 +43,7 @@ Add the `PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY` build flag to ensure reliable O
 
 4. Update dev/platform to staging version:
    - [Instruction for Espressif 8266](http://docs.platformio.org/en/latest/platforms/espressif8266.html#using-arduino-framework-with-staging-version)
+
 5. Add development version of "Homie" to project using `platformio.ini` and [lib_deps](http://docs.platformio.org/page/projectconf/section_env_library.html#lib-deps) option:
 ```ini
 [env:myboard]
@@ -51,11 +52,9 @@ board = ...
 framework = arduino
 build_flags = -D PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY
 
-; the latest development branch
+; the latest development branch (convention V3.0.x) 
 lib_deps = https://github.com/homieiot/homie-esp8266.git#develop-v3
 
-; or tagged version
-lib_deps = https://github.com/homieiot/homie-esp8266.git#v2.0.0-beta.2
 ```
 
 -----
@@ -64,20 +63,20 @@ Happy coding with PlatformIO!
 ## Features
 
 * Automatic connection/reconnection to Wi-Fi/MQTT
-* [JSON configuration file](http://homieiot.github.io/homie-esp8266/docs/develop/configuration/json-configuration-file) to configure the device
-* [Cute HTTP API / Web UI / App](http://homieiot.github.io/homie-esp8266/docs/develop/configuration/http-json-api) to remotely send the configuration to the device and get information about it
-* [Custom settings](http://homieiot.github.io/homie-esp8266/docs/develop/advanced-usage/custom-settings)
-* [OTA over MQTT](http://homieiot.github.io/homie-esp8266/docs/develop/others/ota-configuration-updates)
-* [Magic bytes](http://homieiot.github.io/homie-esp8266/docs/develop/advanced-usage/magic-bytes)
-* Available in the [PlatformIO registry](http://platformio.org/#!/lib/show/555/Homie)
-* Pretty straightforward sketches, a simple light for example:
+* [JSON configuration file](http://homieiot.github.io/homie-esp8266/docs/develop-v3/configuration/json-configuration-file) to configure the device
+* [Cute HTTP API / Web UI / App](http://homieiot.github.io/homie-esp8266/docs/develop-v3/configuration/http-json-api) to remotely send the configuration to the device and get information about it
+* [Custom settings](http://homieiot.github.io/homie-esp8266/docs/develop-v3/advanced-usage/custom-settings)
+* [OTA over MQTT](http://homieiot.github.io/homie-esp8266/docs/develop-v3/others/ota-configuration-updates)
+* [Magic bytes](http://homieiot.github.io/homie-esp8266/docs/develop-v3/advanced-usage/magic-bytes)
+* Available in the [PlatformIO registry](http://platformio.org/#!/lib/show/555/Homie) **Please note that this is the latest release from V2 branch** - see above how to use latest v3 version with platformio.
+* Pretty straightforward sketches, a simple light for example: (**TODO**: adapt to V3)
 
 ```c++
 #include <Homie.h>
 
 const int PIN_RELAY = 5;
 
-HomieNode lightNode("light", "Light", "switch");
+HomieNode lightNode("light", "switch");
 
 bool lightOnHandler(const HomieRange& range, const String& value) {
   if (value != "true" && value != "false") return false;
@@ -98,7 +97,7 @@ void setup() {
 
   Homie_setFirmware("awesome-relay", "1.0.0");
 
-  lightNode.advertise("on", "On", "boolean").settable(lightOnHandler);
+  lightNode.advertise("on").settable(lightOnHandler);
 
   Homie.setup();
 }
@@ -110,7 +109,7 @@ void loop() {
 
 ## Requirements, installation and usage
 
-The project is documented on http://marvinroger.github.io/homie-esp8266/ with a *Getting started* guide and every piece of information you will need.
+The project is documented on https://homieiot.github.io/homie-esp8266/ with a *Getting started* guide and every piece of information you will need.
 
 ## Donate