docs: badge-ify license / deps / why-this-matters to match ci + OpenSSF#41
Merged
Conversation
The MIT, dependency, and "why this matters" items were plain text after the two SVG badges, so on npm they rendered as grey text trailing two colored shields. Convert them to flat shields.io badges (same flat style as the ci and OpenSSF Scorecard badges) so the header reads as one consistent badge row. Also corrects the dependency count 1 -> 3: @modelcontextprotocol/sdk and zod became regular dependencies (from optional) when the MCP server shipped, so "one runtime dependency" was stale.
Merged
askalf
added a commit
that referenced
this pull request
Jul 11, 2026
Docs-only patch so the README badge-row fix (#41) reaches the npm-displayed README. Bumps package.json + package-lock.json 0.4.0 -> 0.4.1 and stamps CHANGELOG [0.4.1].
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
1 participant
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.
What
The README header had two rendered SVG badges (
ci,OpenSSF Scorecard) followed by plain grey text —MIT · one runtime dependency · why this matters →. On npm that reads as two colored shields trailing off into unstyled text. This converts the three trailing items into flat shields.io badges so the header is one consistent badge row.MITlicense | MIT(blue shield →LICENSE)one runtime dependencyruntime deps | 3(green shield →package.json)why this matters →why this matters | the lethal trifecta(violet shield → the doc)All five badges now use the same flat style as the existing
ci/OpenSSF Scorecardbadges.Note — dependency count corrected 1 → 3
package.jsonlists threedependencies(@modelcontextprotocol/sdk,node-html-parser,zod); sdk+zod moved from optional to regular when the MCP server shipped, so "one runtime dependency" was stale. The badge reflects the real count so it can't be contradicted by npm's own dependency list.Reach npm
npm only refreshes the displayed README on a new publish — this rides the next release.