Skip to content

Refresh README badges: live npm version, downloads, CI, and coverage - #30

Merged
frontegg-david merged 1 commit into
mainfrom
docs/readme-badges
Aug 13, 2026
Merged

Refresh README badges: live npm version, downloads, CI, and coverage#30
frontegg-david merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@frontegg-david

@frontegg-david frontegg-david commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Fixes the stale npm-version badge and expands the badge row.

  • Stale version fix: badge.fury.io was serving a cached 2.5.1; switched to shields.io's npm/v, which reads the registry live (verified rendering v2.6.1 right now).
  • New badges: npm monthly downloads (live: 31k/month), CI status (push.yml), and a coverage badge. The coverage badge is a static 100% backed by the CI gatecoverageThreshold fails the build below 100/100/100/100, so the badge cannot silently drift; its link points at the enforcing workflow.
  • Node badge now reads engines from the registry (>=20.0.0) instead of a hand-maintained label.
  • Kept: CodeQL, License, TypeScript.

Docs-only; all three dynamic badge endpoints verified live before commit.

Summary by CodeRabbit

  • Documentation
    • Updated README badges to display npm downloads, CI status, code coverage, supported Node.js version, license, TypeScript, and CodeQL information.

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b9b5c61e-3dcf-4191-bd1d-102ee3098ad0

📥 Commits

Reviewing files that changed from the base of the PR and between eb07387 and 0fb4c65.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The README badge set now includes npm downloads, CI, coverage, and Node version badges. The license, TypeScript, and CodeQL badges remain.

Changes

README Badge Updates

Layer / File(s) Summary
Refresh README badges
README.md
The README replaces the npm Fury badge and adds npm downloads, CI, coverage, and Node version badges. Existing license, TypeScript, and CodeQL badges remain.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Mergeability Score: ⚪ Minimal · up to 0fb4c

This documentation-only change updates README badges without changing product behavior; it is merge-ready after normal checks, with no actionable merge-blocking risk.

Poem

I’m a rabbit with badges bright,
Hopping through the README light.
Downloads, CI, coverage too,
Node now joins the badge crew.
License and types still stay in view—
CodeQL keeps watch as rabbits do.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README badge refresh, including live npm version, download, CI, and coverage badges.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-badges

Comment @coderabbitai help to get the list of available commands.

@frontegg-david
frontegg-david merged commit f7460b8 into main Aug 13, 2026
8 checks passed
@frontegg-david
frontegg-david deleted the docs/readme-badges branch August 13, 2026 01:50
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.

1 participant