Skip to content

docs: redesign README with SVG hero + architecture diagram - #16

Merged
revxshafi merged 1 commit into
mainfrom
docs/readme-redesign
Aug 22, 2026
Merged

docs: redesign README with SVG hero + architecture diagram#16
revxshafi merged 1 commit into
mainfrom
docs/readme-redesign

Conversation

@revxshafi

Copy link
Copy Markdown
Collaborator

Summary

Full visual redesign of the README, generated with the beautify-github-readme workflow.

  • New assets (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 a swapEngine() 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 bidirectional engineSwap() bar.
  • Restructured example-first: quick start leads, "same code, production engine" is the proof section, a new "How it works" section wraps the diagram.
  • Badges: npm version, TS types, node engine, MIT — all derived from the published package, nothing fabricated.
  • All technical tables preserved (reliability, migration guarantees, API, limits); duplicated prose trimmed.

Testing

  • Rendered both SVGs at 900px and 360px (@resvg/resvg-js) — text clears the skill's size thresholds, structure holds on mobile.
  • No forbidden SVG features (<script>, foreignObject, remote refs/fonts); each asset has <title>/<desc>/viewBox.
  • No broken markdown / dead links (./LICENSE valid). Docs-only change — no source, tests, or public API touched.

🤖 Generated with Claude Code

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)
@revxshafi
revxshafi merged commit 6101694 into main Aug 22, 2026
8 checks passed
@revxshafi
revxshafi deleted the docs/readme-redesign branch August 22, 2026 08:40
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