Cleaned up readme

This commit is contained in:
cschwinne 2018-10-04 23:16:25 +02:00
parent c1cdf27507
commit 75a61f85db

View File

@ -1,32 +1,34 @@
![WLED logo](https://raw.githubusercontent.com/Aircoookie/WLED/development/wled_logo.png) ![WLED logo](https://raw.githubusercontent.com/Aircoookie/WLED/development/wled_logo.png)
## Welcome to my project WLED! ## Welcome to my project WLED! (v0.8.0)
WLED is a fast, advanced and (relatively) secure implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B) LEDs! A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B) LEDs!
### Features: (v0.8.0) ### Features:
- RGB, HSB, and brightness sliders - WS2812FX library integrated for over 70 special effects
- All new, mobile-friendly web UI! - FastLED noise effects and palettes
- Customizable Mobile and desktop UI with color and effect controls
- Settings page - configuration over network - Settings page - configuration over network
- Access Point and station mode - automatic failsafe AP - Access Point and station mode - automatic failsafe AP
- Support of Blynk IoT cloud and MQTT
- WS2812FX library integrated for over 70 special effects (with FastLED palettes)!
- Secondary color support lets you use even more effect combinations
- Alexa smart home device server (including dimming)
- Beta syncronization to Philips hue lights
- Realtime UDP Packet Control (E1.31, Hyperion, WARLS, DRGB, DRGBW)
- Support for RGBW strips - Support for RGBW strips
- 25 user presets! Save colors and effects and apply them easily! Supports cycling through them. - 25 user presets to save and load colors/effects easily, supports cycling through them.
- HTTP request API for simple integration
- Macro functions to automatically execute API calls - Macro functions to automatically execute API calls
- Nightlight function (gradually dims down) - Nightlight function (gradually dims down)
- Notifier function (multiple ESPs sync color via UDP broadcast) - Full OTA software updatability (HTTP + ArduinoOTA), password protectable
- Support for power pushbutton - Configurable analog clock + support for the Cronixie kit by Diamex
- Support for the Adalight serial ambilight protocol!
- Full OTA software update capability (HTTP and ArduinoOTA) ### Supported light control interfaces:
- Password protected OTA page for added security (OTA lock) - HTTP request API
- NTP and configurable analog clock function - Blynk IoT
- Support for the Cronixie Clock kit by Diamex - MQTT
- E1.31
- Hyperion
- UDP realtime
- Alexa smart device (including dimming)
- Sync to Philips hue lights
- Adalight (PC ambilight via serial)
- Sync color of multiple WLED devices (UDP notifier)
- Simple timers/schedules (time from NTP, timezones/DST supported)
### Quick start guide and documentation: ### Quick start guide and documentation:
@ -40,8 +42,8 @@ Credits in About page!
Uses Linearicons by Perxis! Uses Linearicons by Perxis!
Join the Discord [server](https://discord.gg/KuqP7NE) to discuss everything about WLED! Join the Discord [server](https://discord.gg/KuqP7NE) to discuss everything about WLED!
You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com). You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com).
If you insist that you just love WLED too much, you can [send me a gift](https://paypal.me/aircoookie) If you insist that you just love WLED too much, you can [send me a gift](https://paypal.me/aircoookie)!