README and site: what drives adoption (2026-09-27)
Stream K’s study of 15 dev-tool READMEs and four landing pages, and what vx takes from it. Raw READMEs read on 2026-09-27; landing pages read from their repos’ source (the sites and github.com/trending were unreachable from the container, 403, so a stars-sorted search of repos created since 2026-08-27 stood in for trending).
Findings
Section titled “Findings”- One hero sentence, 8–15 words, naming the category. uv: “An extremely fast Python package and project manager, written in Rust.” Ruff the same shape. Hono “ultrafast”, Tauri “blazingly fast”. Newer heroes lead with position over speed (Turborepo: “the build system for coding agents”).
- Dark/light assets through
<picture>: 9 of 15 (Vite, Oxc, Biome, Nx, Turborepo, Excalidraw, uv and Ruff’s charts; Drizzle via#gh-dark-mode-only). - The benchmark chart is the second thing seen when speed is the thesis. uv and Ruff: a bar chart, dark and light SVGs, a one-line caption naming the workload; uv links its claim to BENCHMARKS.md (caveats, “lower is better”, a reproduction script). Biome’s site animates bars with the hardware and file count in the caption.
- Migration reads as parity, not a guide. uv: “drop-in replacement
… without changing your existing workflows”. Ruff: “drop-in parity
with Flake8, isort, and Black”. Biome: “97% compatibility with
Prettier”. Nx: “
npx nx init… no changes to your setup required”. - Install within ~50 lines, one copyable line. uv 44, Bun 44, Biome 49, Ollama 16. Projects that defer install to the site (Turborepo, Nx, Zed) are company-backed and already known.
- Social proof, strongest first: named testimonials with numbers (Ruff), named adopters (Oxc, Vite, Biome), live metrics (Nx, Turborepo), sponsor walls, a stars badge.
- Landing template (Vite, Oxc, Biome, Turborepo): headline + one-line subhead, Get started + GitHub, a copyable install box, one visual proof, a logo strip, 3–7 feature cards, a footer CTA.
- Transcript demos with timings (uv’s “Resolved 2 packages in 170ms”) put the speed proof inside the quick start. A playground link (Biome, Oxc, Ruff).
- Short READMEs that defer to the site work only once famous. uv, Ruff, Bun and Ollama grew through a README that stands alone.
Applied to vx
Section titled “Applied to vx”- Root README (also the
@vzn/vxnpm page): centred logo, the site’s hero line, four badges, a dark/light benchmark chart generated frompackages/vx-bench/results.jsonbyupdate-site.ts(so it cannot drift from the numbers;check.siteholds it), install on one line, a quick start run end to end (init, a cache block, miss → up-to-date → restored), “Already on Turborepo or Nx?” as parity (turbo()/nx()with nothing rewritten, thenbunx @vzn/vx-migrate), six why bullets, the comparison table, a plugin table. Architecture, lock and mapping details moved to the docs they repeated. - Not taken: testimonials and adopter logos (vx has none to cite yet); a stars badge (no signal at this size).
Checklist (2026-09-28)
Section titled “Checklist (2026-09-28)”The ten patterns a second pass named (uv, ruff, bun, biome, vite, turborepo, oxc, rolldown), each against where vx stands:
| Pattern | Seen in | vx |
|---|---|---|
| One-line hero | all eight | README and landing title (K-15) |
| Benchmark chart above the fold | uv, ruff, biome | dark/light SVG from results.json, held by check.site (K-1) |
| One-line install | uv, bun, biome | npm install -D @vzn/vx |
| Three-command quick start | uv, bun, vite | vx init, one cache block, vx run build twice |
| Terminal demo as SVG | uv (transcript), biome | demo.svg from a real run, held by terminal-demo.ts --check (K-6); animated in K-19 |
| Why in three bullets | ruff, uv | six bullets: each is a claim a comparison row backs; not cut |
| Comparison table | biome, turborepo | Turbo, Nx, moon columns (K-13) |
| Used by / real repos | oxc, vite, biome | fourteen benched repos (K-14, K-16, K-17) |
| Minimal badges | uv (3), ruff (5) | four; rolldown shows eleven, the outlier |
| Social preview image | all eight | 1200×630 og.png on every page (K-3) |
Rolldown adds one: a “try it in the browser” link (StackBlitz). vx has the playground (K-11). It defers everything else to its site, pattern 9.
Sources
Section titled “Sources”https://raw.githubusercontent.com/<repo>/HEAD/README.mdfor oven-sh/bun, vitejs/vite, rolldown/rolldown, biomejs/biome (andpackages/@biomejs/biome/README.md), oxc-project/oxc, astral-sh/uv (andBENCHMARKS.md), astral-sh/ruff, vercel/turborepo, nrwl/nx, tauri-apps/tauri, zed-industries/zed, shadcn-ui/ui, excalidraw/excalidraw, ollama/ollama, honojs/hono, drizzle-team/drizzle-orm.- Landing source: vitejs/vite
docs/.vitepress/theme/landing/, oxc-project/website.vitepress/theme/landing/, biomejs/websitesrc/content/docs/en/index.mdx, vercel/turborepoapps/docs/app/[lang]/(home)/page.tsx. - Not reached (403): bun.sh, vite.dev, biomejs.dev, oxc.rs, turborepo.com, nx.dev, github.com/trending.