Skip to content

docs: world-class README badges (npm, coverage, provenance) - #27

Merged
saucam merged 1 commit into
mainfrom
docs/readme-badges
Jun 24, 2026
Merged

docs: world-class README badges (npm, coverage, provenance)#27
saucam merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@saucam

@saucam saucam commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Upgrades the header badges now that codeoid ships as a published, provenance-signed, coverage-tracked package:

  • npm versionv0.1.1 (live)
  • npm downloads (monthly)
  • CI (kept)
  • Codecov coverage → renders 81%
  • published with provenance (OIDC Trusted Publishing)
  • License: MIT · Runtime: Bun · TypeScript · PRs welcome

All badge URLs verified to resolve with real values (npm v0.1.1, Codecov 81%).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the README badges row to add npm version, npm downloads, code coverage, and provenance, and removed the prior “PRs welcome” badge.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: dfc79551-ce69-4772-8373-4039f69e8af4

📥 Commits

Reviewing files that changed from the base of the PR and between 334f5c8 and 916b121.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The README header badge row is updated to include four new Markdown badge links for npm version, npm downloads, codecov coverage, and published-with-provenance status. The "PRs welcome" badge is removed. Existing CI, MIT license, and Bun runtime badges are retained.

Changes

README Badge Updates

Layer / File(s) Summary
README badge row expansion
README.md
Adds npm version, npm downloads, codecov, and published-with-provenance badges to the existing top-of-file badge section; removes "PRs welcome" badge.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 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 specifically summarizes the main change: adding world-class README badges for npm, coverage, and provenance metadata.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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.

@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.61%. Comparing base (35fd681) to head (916b121).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #27   +/-   ##
=======================================
  Coverage   80.61%   80.61%           
=======================================
  Files          45       45           
  Lines        4782     4782           
=======================================
  Hits         3855     3855           
  Misses        927      927           
Flag Coverage Δ
daemon 80.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@saucam
saucam force-pushed the docs/readme-badges branch from 5e35b73 to 334f5c8 Compare June 23, 2026 23:41
…ance)

Now that codeoid is published with OIDC provenance and Codecov-tracked,
surface npm version + monthly downloads, code coverage, a provenance badge,
and a TypeScript badge alongside CI/license/runtime/PRs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@saucam
saucam force-pushed the docs/readme-badges branch from 334f5c8 to 916b121 Compare June 24, 2026 00:41
@saucam
saucam merged commit 721bc09 into main Jun 24, 2026
5 checks passed
@saucam saucam mentioned this pull request Jun 28, 2026
saucam added a commit that referenced this pull request Jun 28, 2026
Patch release rolling up six fixes/doc changes since v0.1.1:

- file explorer switches workdir on session change (#37)
- interrupted tool calls marked cancelled, not failed (#35)
- writeBatch guarded against in-flight streams; no TUI double-print (#33)
- TUI reconnects + re-mints token on JWT expiry (#34)
- Telegram /attach disconnects old session before switching (#29)
- richer README badges (#27)

Bumps package.json to 0.1.2 so the release.yml tag check passes, and
backfills the previously-undocumented 0.1.1 entry in the CHANGELOG.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.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.

1 participant