From 8b6feb6b0814157aeb1c0f53dc6aec925f658698 Mon Sep 17 00:00:00 2001 From: Tobias Blum Date: Mon, 9 May 2016 18:03:39 +0200 Subject: [PATCH] Updated readme.md with initial infos. --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ea2817c..c1c6b87 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# McLighting -The ESP8266 based multi-client lighting gadget +# McLighting - The ESP8266 based multi-client lighting gadget + +> Mc Lighting (the multi-client lighting gadget) is a very cheap internet-controllable lighting solution based on the famous ESP8266 microcontroller and WS2811/2812 led strips. It features a self-hosted responsive web-interface, a REST-API and a websocket connector. + +> Because of it's open architecture and APIs it's easy to build new clients for different platforms (iOS, Android, Windows Universal Apps, Siri/Cortana integration, ...). + +## The Hardware +- A NodeMCU development board, based on the ESP8266 ESP-12E, (that you can get for under 5 USD from eBay). A standalone ESP8266 or a Adafruit Huzzah should work too. +- A WS2811 or WS2812 led strip that you can get in many sizes and forms. I'm using a ring of 12 leds. When you use more than about 15-20 leds you may have to use a dedicated 5V power source. +- Power via USB + +## Licence +MIT + + + + +*More information will be added as soon as I clean up the code.*