Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New readme design #973

Merged
merged 14 commits into from
Jun 8, 2020
Merged

New readme design #973

merged 14 commits into from
Jun 8, 2020

Conversation

w00000dy
Copy link
Contributor

@w00000dy w00000dy commented Jun 7, 2020

  • added emojis
  • changed the first sentence (information about WS2801)
  • added images
  • added discord banner

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.

w00000dy added 10 commits June 7, 2020 23:18
- added emojis
- changed the first sentence (information about WS2801)
- added images
- added discord banner
- replaced email with image (protection for spam bots)
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.
@Aircoookie
Copy link
Member

I love this! The emojis really help the project look a lot more inviting!
The pictures are also mega cool, just as in a commercial product ad!
Just one question to make sure before I merge - do we have the usage rights to these images? I just don't want to get in trouble by infringing on the photographer's or Apple's copyright or trademarks.
Also before merging I would scale them down/reduce the JPEG quality a bit to reduce the file size to 1MB. That is good practice because otherwise any readme load would take way to much bandwidth. Hope that's alright for you :)

@w00000dy
Copy link
Contributor Author

w00000dy commented Jun 8, 2020

I made these pictures with Mockuuups Studio. They are free to use. You can find informations about the license here.
I also compressed the images. Now they have a small size.

@Aircoookie
Copy link
Member

Awesome, thanks!

@Aircoookie Aircoookie merged commit 3d1f883 into wled:master Jun 8, 2020
@w00000dy
Copy link
Contributor Author

w00000dy commented Jun 8, 2020

Can you also change the description of your project to something like this: Control WS2801, WS2812B, WS2811, SK6812, APA102 and much more RGB LEDs with an ESP8266/ESP32 over WiFi!
I think this is more accurate. 😁

@Aircoookie
Copy link
Member

Changed it to Control WS2812B and many more types of digital RGB LEDs with an ESP8266 or ESP32 over WiFi!. I think we shouldn't list too many, it should be short and to the point :) But you are right that pointing out the compatibility is a great idea! The old description was the same since 2016 haha

@w00000dy
Copy link
Contributor Author

w00000dy commented Jun 8, 2020

Nice, thanks!

@mike2nl
Copy link
Contributor

mike2nl commented Jun 8, 2020

@WoodyLetsCode
very well done.

  • one question/idea about the design.
    In my 2 cents i would make the discord link/image 50% smaller

@w00000dy
Copy link
Contributor Author

w00000dy commented Jun 8, 2020

Okay. I made a pull request for this: #976

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants