Skip to content

Increased readme badges#284

Open
thompson-tomo wants to merge 4 commits intothlorenz:masterfrom
thompson-tomo:patch-1
Open

Increased readme badges#284
thompson-tomo wants to merge 4 commits intothlorenz:masterfrom
thompson-tomo:patch-1

Conversation

@thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Dec 2, 2025

Add the npm version badge as well as the most recent npm release to give more info.

@PeterDaveHello
Copy link
Collaborator

Is there any reason to use a third-party badge instead of the official one when the existing one works well? I mean the CI badge: https://github.com/thlorenz/doctoc/actions/workflows/node.js.yml/badge.svg

@thompson-tomo
Copy link
Contributor Author

Because it was a different color/style to the other 2 so changing it made it uniformed.

@PeterDaveHello
Copy link
Collaborator

Since the badges are visually distinct, reducing third-party dependencies will be better.

@thompson-tomo
Copy link
Contributor Author

But it doesn't decrease third party dependencies as it is the same dependency as the other 2 badges.

Once a new release occurs, the 3rd badge will switch to green from the Red. With this change that green would be the same green otherwise it would be a different green, in fact it would even have a gradient.

@PeterDaveHello
Copy link
Collaborator

Thanks for the follow-up. I see where you're coming from regarding visual style.

However, since badge colors are dynamic and change based on status (passing vs. failing), perfect uniformity isn't really a permanent state we can rely on. I prefer to prioritize the reliability of the official source over matching the exact shade of green.

Would you be willing to revert the CI badge? I'd be happy to merge the rest of your contributions.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds additional README badges to surface npm package metadata alongside the existing CI status badge.

Changes:

  • Switch the GitHub Actions badge to a shields.io-based badge.
  • Add npm version and “last update” badges to the README header.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

2 participants