diff --git a/images/macbook-pro-space-gray-on-the-wooden-table.webp b/images/macbook-pro-space-gray-on-the-wooden-table.webp new file mode 100644 index 00000000..cd728d84 Binary files /dev/null and b/images/macbook-pro-space-gray-on-the-wooden-table.webp differ diff --git a/images/walking-with-iphone-x.webp b/images/walking-with-iphone-x.webp new file mode 100644 index 00000000..24b55f0f Binary files /dev/null and b/images/walking-with-iphone-x.webp differ diff --git a/wled_logo.png b/images/wled_logo.png similarity index 100% rename from wled_logo.png rename to images/wled_logo.png diff --git a/readme.md b/readme.md index 378345d6..b30f52ed 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,5 @@
-## Welcome to my project WLED! +# 👋 Welcome to my project WLED! -A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812, APA102) LEDs! +A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812, APA102) LEDs or also SPI based chipsets like the WS2801! -### Features: +## ⚙️ Features - WS2812FX library integrated for over 100 special effects - FastLED noise effects and 50 palettes - Modern UI with color, effect and segment controls @@ -26,7 +26,7 @@ A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control - Configurable analog clock + support for the Cronixie kit by Diamex - Configurable Auto Brightness limit for safer operation -### Supported light control interfaces: +## 💡 Supported light control interfaces - WLED app for Android and iOS - JSON and HTTP request APIs - MQTT @@ -41,7 +41,7 @@ A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control - Infrared remotes (24-key RGB, receiver required) - Simple timers/schedules (time from NTP, timezones/DST supported) -### Quick start guide and documentation: +## 📲 Quick start guide and documentation See the [wiki](https://github.com/Aircoookie/WLED/wiki)! @@ -55,18 +55,39 @@ Russian speakers, check out the videos by Room31: [WLED Firmware Overview: Interface and Settings](https://youtu.be/h7lKsczEI7E) [ESP8266 based LED controller for WS2812b strip. WLED Firmware + OpenHAB](https://youtu.be/K4ioTt3XvGc) -### Other +## 🖼️ Images + + +## 💾 Compatible LED Strips +Type | Voltage | Comments +|---|---|---| +WS2812B | 5v | +WS2813 | 5v | +SK6812 | 5v | RGBW +APA102 | 5v | C/D +WS2801 | 5v | C/D +LPD8806 | 5v | C/D +TM1814 | 12v | RGBW +WS2811 | 12v | 3-LED segments +WS2815 | 12v | +GS8208 | 12v | + +## ✌️ Other Licensed under the MIT license Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)! Uses Linearicons by Perxis! -Join the Discord [server](https://discord.gg/KuqP7NE) to discuss everything about WLED! +Join the Discord server to discuss everything about WLED! + +[![WLED Discord](https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2)](https://discord.gg/KuqP7NE) + Check out the WLED [Discourse forum](https://wled.discourse.group)! You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com), but please only do so if you want to talk to me privately. If WLED really brightens up your every day, you can [![](https://img.shields.io/badge/send%20me%20a%20small%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie) + *Disclaimer:* If you are sensitive to photoeleptic seizures it is not recommended that you use this software. In case you still want to try, don't use strobe, lighting or noise modes or high effect speed settings.