docs: hand-drawn badge row in README#117
Merged
Merged
Conversation
Use our own Badge component to render the four marketing badges (npm / license / drawn-with / vibe) at the top of the README. Eats the dog food and pitches the new render-badge / render-github-badge MCP tools. System font (sans-serif) instead of the bundled Caveat so each SVG is ~5 KB instead of ~70 KB; the README chrome can't justify 280 KB of font bytes. scripts/render-readme-badges.mjs regenerates them; re-run after version bumps or palette tweaks. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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.
Adds four hand-drawn badges to the top of
README.md, rendered by the newBadgecomponent itself (eats our own dog food, lightly pitches the newrender-badge/render-github-badgeMCP tools).npm v0.2.0— tag icon, info tonelicense MIT— license icon, neutral tonedrawn with rough.js— no icon, neutral tonedefault vibe chaotic_notebook— star icon, info toneNotes
sans-serif) — bundled Caveat would push each SVG to ~70 KBand the four-badge row would weigh ~280 KB. Trade the script-y font on the
badges for ~21 KB total.
scripts/render-readme-badges.mjsregenerates the SVGs; re-run after aversion bump or palette tweak. No CI wiring — these are static marketing
surface, not a live status dashboard.
npm v0.2.0) will go stale on the next release. TheREADME's quickstart still points at
npm install goldenchartfor the livetruth.