docs: redesign README with SVG hero + architecture diagram - #16
Merged
Conversation
Restructure README example-first (quick start leads, Postgres switch as proof) and add a visual system: a pure-SVG hero (name, tagline, engine-swap motif) and a how-it-works architecture diagram, both self-backgrounded for light/dark GitHub themes. Add real npm/types/node/license badges. Content tables (reliability, migration guarantees, API, limits) preserved, repeated prose trimmed. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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.
Summary
Full visual redesign of the README, generated with the
beautify-github-readmeworkflow.assets/readme/, pure SVG, self-backgrounded for light/dark themes):hero.svg— split hero: identity + real metadata on the left, the engine-swap motif (one.key(id).set(v)call fanning into SQLite and PostgreSQL cards with aswapEngine()two-way arrow) on the right.architecture.svg— "How it works" system map: fluent chain → write collector → lazy mode-gated driver → SQLite files / Postgres schemas, with the bidirectionalengineSwap()bar.Testing
@resvg/resvg-js) — text clears the skill's size thresholds, structure holds on mobile.<script>,foreignObject, remote refs/fonts); each asset has<title>/<desc>/viewBox../LICENSEvalid). Docs-only change — no source, tests, or public API touched.🤖 Generated with Claude Code