New readme design (#973)
* nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg
This commit is contained in:
parent
8613a89931
commit
3d1f883465
BIN
images/macbook-pro-space-gray-on-the-wooden-table.webp
Normal file
BIN
images/macbook-pro-space-gray-on-the-wooden-table.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 284 KiB |
BIN
images/walking-with-iphone-x.webp
Normal file
BIN
images/walking-with-iphone-x.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 155 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
37
readme.md
37
readme.md
@ -1,5 +1,5 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="/wled_logo.png">
|
<img src="/images/wled_logo.png">
|
||||||
<a href="https://github.com/Aircoookie/WLED/releases"><img src="https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square"></a>
|
<a href="https://github.com/Aircoookie/WLED/releases"><img src="https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square"></a>
|
||||||
<a href="https://wled.discourse.group"><img src="https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square"></a>
|
<a href="https://wled.discourse.group"><img src="https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square"></a>
|
||||||
<a href="https://discord.gg/KuqP7NE"><img src="https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square"></a>
|
<a href="https://discord.gg/KuqP7NE"><img src="https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square"></a>
|
||||||
@ -7,11 +7,11 @@
|
|||||||
<a href="https://github.com/Aircoookie/WLED-App"><img src="https://img.shields.io/badge/app-wled-blue.svg?style=flat-square"></a>
|
<a href="https://github.com/Aircoookie/WLED-App"><img src="https://img.shields.io/badge/app-wled-blue.svg?style=flat-square"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 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
|
- WS2812FX library integrated for over 100 special effects
|
||||||
- FastLED noise effects and 50 palettes
|
- FastLED noise effects and 50 palettes
|
||||||
- Modern UI with color, effect and segment controls
|
- 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 analog clock + support for the Cronixie kit by Diamex
|
||||||
- Configurable Auto Brightness limit for safer operation
|
- Configurable Auto Brightness limit for safer operation
|
||||||
|
|
||||||
### Supported light control interfaces:
|
## 💡 Supported light control interfaces
|
||||||
- WLED app for Android and iOS
|
- WLED app for Android and iOS
|
||||||
- JSON and HTTP request APIs
|
- JSON and HTTP request APIs
|
||||||
- MQTT
|
- 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)
|
- Infrared remotes (24-key RGB, receiver required)
|
||||||
- Simple timers/schedules (time from NTP, timezones/DST supported)
|
- 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)!
|
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)
|
[WLED Firmware Overview: Interface and Settings](https://youtu.be/h7lKsczEI7E)
|
||||||
[ESP8266 based LED controller for WS2812b strip. WLED Firmware + OpenHAB](https://youtu.be/K4ioTt3XvGc)
|
[ESP8266 based LED controller for WS2812b strip. WLED Firmware + OpenHAB](https://youtu.be/K4ioTt3XvGc)
|
||||||
|
|
||||||
### Other
|
## 🖼️ Images
|
||||||
|
<img src="/images/macbook-pro-space-gray-on-the-wooden-table.webp" width="50%"><img src="/images/walking-with-iphone-x.webp" width="50%">
|
||||||
|
|
||||||
|
## 💾 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
|
Licensed under the MIT license
|
||||||
Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)!
|
Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)!
|
||||||
|
|
||||||
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 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)!
|
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.
|
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)
|
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:*
|
*Disclaimer:*
|
||||||
If you are sensitive to photoeleptic seizures it is not recommended that you use this software.
|
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.
|
In case you still want to try, don't use strobe, lighting or noise modes or high effect speed settings.
|
||||||
|
Loading…
Reference in New Issue
Block a user