svgo icon indicating copy to clipboard operation
svgo copied to clipboard

Update badges in README.md

Open MichaelHinrichs opened this issue 1 year ago • 3 comments

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

MichaelHinrichs avatar Jun 21 '24 22:06 MichaelHinrichs

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

GreLI avatar Jun 27 '24 20:06 GreLI

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

This says it needs node 22.3.0.

MichaelHinrichs avatar Jun 28 '24 16:06 MichaelHinrichs

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

GreLI avatar Jun 28 '24 16:06 GreLI

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 https://github.com/badges/shields/issues/5497 and https://github.com/badges/shields/pull/9916. Even I find the badges hard/uncomfortable to read, even though I love the project.

SethFalco avatar Jul 02 '24 09:07 SethFalco