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

Update badges in README.md #2041

Closed
wants to merge 6 commits into from
Closed

Conversation

MichaelHinrichs
Copy link

Add NPM and Discord logos. Label Discord badge as "Discord". Set Discord badge Color to 5865F2, Discord's official "Blurple" color.

Add NPM and Discord logos. Label Discord badge as "Discord". Set Discord badge Color to 5865F2, Discord's official "Blurple" color.
@GreLI
Copy link
Member

GreLI commented Jun 27, 2024

Who maintains brew svgo package and how it works? Does it need node.js?

@MichaelHinrichs
Copy link
Author

Here.
https://formulae.brew.sh/formula/svgo#default

This says it needs node 22.3.0.

@GreLI
Copy link
Member

GreLI commented Jun 28, 2024

Hmm, seems like the bottle is there for 7 years. Seems like updated automatically, probably from the github release.

@SethFalco
Copy link
Member

SethFalco commented Jul 2, 2024

I'm not seeing the benefit to most of this. It adds bloat to the README with information no one is asking for, and most of it is readily available at the links we do have.

UX extends to project documentation and the README too, and this overall offers a worse experience for people learning about the project. For example, scattering around icons and colors everywhere with meaningless stats doesn't help anyone, it just distracts them from the more important information we actually do want them to read.

Some things I do like about this PR:

  • Stating discord instead of chat, so it's immediately obvious where the badge leads. (However, I would prefer a lowercase discord to follow the casing conventions for badges.)
  • Adding an icon to badges. However, for consistency, if we're going to add an icon to one, I'd prefer if we picked appropriate icons for the rest too. (This assumes no Yarn badge, as the icon for that is so illegible that it would make me want to scrap icons entirely.)
  • The separation of the installation methods into different code blocks, so they're easy to copy and paste with a click.

Some things I disliked:

  • Adding the license badge, as GitHub and npm already displays the license.
  • Reorganizing the badges, the order was fine before.
  • Redundant alt text for badges, screen reader users don't want NPM Downloads read to them 4+ times, for example.

I originally closed the PR as I was distracted by the cluster of badges, but I do realize now that there was some good in it too. If you'd like, you're welcome to open another PR that addresses some of the issues raised.

Edit: As an aside, before adding more badges from shields.io, I'd been keen to see them address badges/shields#5497 and badges/shields#9916. Even I find the badges hard/uncomfortable to read, even though I love the project.

@SethFalco SethFalco closed this Jul 2, 2024
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.

None yet

3 participants