docs(readme): add Socket, CI, release, and npm badges - #407
Merged
Merged
Conversation
Contributor
File size check0 over a hard cap (fails), 30 warning(s).
Split the file, wrap the line, shorten or exempt the comment, or list the path in 5 managed file(s) skipped; repo-platform owns them. |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation-only change is correct and matches the stated purpose.
Review effort: Balanced
Findings: None
What changed in this PR
Adds package health, CI, release, and npm version badges to the README.
Changes:
- Adds five linked badges below the title.
- Tracks CI on
main, releases, and npmlatest/nextversions.
| File | Description |
|---|---|
README.md |
Adds the badge row. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Vivswan
marked this pull request as ready for review
September 22, 2026 08:52
Vivswan
force-pushed
the
wt/readme-badges
branch
from
September 22, 2026 09:11
4eea083 to
b782c13
Compare
Vivswan
added
the
merge-when-green
Add one badge row directly under the README title: Socket, CI on main, latest release, npm latest, and npm next. The Socket badge is unpinned so it tracks the package rather than one pre-release. No license badge: the package license field is "SEE LICENSE IN LICENSE.md", which shields renders as "not identifiable".
Vivswan
force-pushed
the
wt/readme-badges
branch
from
September 22, 2026 09:37
b782c13 to
370330d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before
After
How
main, latest release, npmlatest, npmnext.ci.ymlruns filtered tomain, the latest release, the npm package page, and the npm versions tab.Proof
bun test test/docsgreen (389 pass); the link tests skiphttps://targets, so the five external links add no assertion.bun run lint,bun run build:checkgreen; the README stays ASCII.Technical details
package.jsondeclares"license": "SEE LICENSE IN LICENSE.md", which shields renders as "not identifiable".README.md(the badge row and its blank line).BEGIN_COMMIT_OVERRIDE
docs(readme): add Socket, CI, release, and npm badges
Add one badge row directly under the README title: Socket, CI on main, latest release, npm latest, and npm next.
The Socket badge is unpinned so it tracks the package rather than one pre-release.
No license badge: the package license field is "SEE LICENSE IN LICENSE.md", which shields renders as "not identifiable".
END_COMMIT_OVERRIDE