docs: refresh README to reflect current feature set and project state#5626
docs: refresh README to reflect current feature set and project state#5626netmindz wants to merge 6 commits into
Conversation
WalkthroughThe README.md file undergoes a comprehensive documentation refresh. The introduction and features section are rewritten to emphasize ESP32 as the primary platform and expand capability descriptions. Navigation sections and community information are updated, and the disclaimer is reformatted with adjusted phrasing. ChangesREADME Content and Structure Refresh
Suggested labels
Suggested reviewers
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
coderabbitai
Bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@readme.md`:
- Line 88: The Discord widget image tag is missing alt text; update the <img>
element inside the anchor (the Discord banner widget) to include a meaningful
alt attribute (e.g., alt="Discord server banner" or similar) so screen readers
can describe the image, ensuring the anchor and image markup remain unchanged
except for adding the alt text.
- Line 74: The two <img> tags lack alt attributes, which breaks accessibility;
update the image tags for
"/images/macbook-pro-space-gray-on-the-wooden-table.jpg" and
"/images/walking-with-iphone-x.jpg" to include concise, descriptive alt text
(e.g., "MacBook Pro space gray on wooden table" and "Person walking holding an
iPhone X"), or use empty alt="" if the image is purely decorative, ensuring
screen readers get meaningful descriptions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| ## 🖼️ User interface | ||
|
|
||
| <img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" width="50%"><img src="/images/walking-with-iphone-x.jpg" width="50%"> |
There was a problem hiding this comment.
Add alt text to images for accessibility.
The images are missing alternative text, preventing screen readers from describing them to visually impaired users.
♿ Proposed fix to add descriptive alt text
-<img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" width="50%"><img src="/images/walking-with-iphone-x.jpg" width="50%">
+<img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" alt="WLED web interface on MacBook Pro" width="50%"><img src="/images/walking-with-iphone-x.jpg" alt="WLED mobile app on iPhone" width="50%">📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" width="50%"><img src="/images/walking-with-iphone-x.jpg" width="50%"> | |
| <img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" alt="WLED web interface on MacBook Pro" width="50%"><img src="/images/walking-with-iphone-x.jpg" alt="WLED mobile app on iPhone" width="50%"> |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 74-74: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 74-74: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@readme.md` at line 74, The two <img> tags lack alt attributes, which breaks
accessibility; update the image tags for
"/images/macbook-pro-space-gray-on-the-wooden-table.jpg" and
"/images/walking-with-iphone-x.jpg" to include concise, descriptive alt text
(e.g., "MacBook Pro space gray on wooden table" and "Person walking holding an
iPhone X"), or use empty alt="" if the image is purely decorative, ensuring
screen readers get meaningful descriptions.
|
|
||
| Join the Discord server to discuss everything about WLED! | ||
|
|
||
| <a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a> |
There was a problem hiding this comment.
Add alt text to Discord widget for accessibility.
The Discord widget image is missing alternative text for screen readers.
♿ Proposed fix to add alt text
-<a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>
+<a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" alt="Join WLED Discord server" width="25%"></a>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a> | |
| <a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" alt="Join WLED Discord server" width="25%"></a> |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 88-88: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@readme.md` at line 88, The Discord widget image tag is missing alt text;
update the <img> element inside the anchor (the Discord banner widget) to
include a meaningful alt attribute (e.g., alt="Discord server banner" or
similar) so screen readers can describe the image, ensuring the anchor and image
markup remain unchanged except for adding the alt text.
| - [**200+ built-in effects**](https://kno.wled.ge/features/effects/) including classic animations, audio-reactive, and 2D/matrix effects | ||
| - [50+ color palettes](https://kno.wled.ge/features/palettes/) plus a built-in **custom palette editor** (PixelForge) | ||
| - [**2D LED matrix support**](https://kno.wled.ge/advanced/mapping/) with dedicated 2D effects and flexible panel mapping | ||
| - [**HUB75 RGB matrix panel support**](https://kno.wled.ge/advanced/HUB75/) (ESP32) |
There was a problem hiding this comment.
Could mention "classic esp32" and "esp32-S3" - but the statement should not become too "chatty"
| - [**2D LED matrix support**](https://kno.wled.ge/advanced/mapping/) with dedicated 2D effects and flexible panel mapping | ||
| - [**HUB75 RGB matrix panel support**](https://kno.wled.ge/advanced/HUB75/) (ESP32) | ||
| - [**AudioReactive**](https://kno.wled.ge/advanced/audio-reactive/) effects — included by default, responding to sound via microphone, line-in, or network audio source | ||
| - Effect blending for smooth transitions between animations |
There was a problem hiding this comment.
Effect layering to combine several effects into one (gimp-like).
|
|
||
| ### Hardware Support | ||
| - **ESP32** (all variants: original, S2, S3, C3) | ||
| - [**Up to 17 LED outputs**](https://kno.wled.ge/features/multi-strip/) on ESP32 using parallel I2S + RMT |
There was a problem hiding this comment.
"Up to 17" is for classic esp32, right?
| Check out the WLED [Discourse forum](https://wled.discourse.group)! | ||
|
|
||
| If WLED really brightens up your day, you can [](https://paypal.me/aircoookie) | ||
| If you'd like to reach the original creator privately: [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com). |
There was a problem hiding this comment.
OK by AC? Or should we leave this out, to reduce spam in his inbox?
2 participants
This pull request updates the
readme.mdto provide a more comprehensive, modern, and user-friendly project overview. The changes improve clarity, detail, and structure, making it easier for new and existing users to understand WLED’s features, hardware compatibility, and community resources.Major documentation improvements:
Community and licensing updates:
General polish and accessibility:
Summary by CodeRabbit
Documentation