docs(readme): rewrite as a switcher's pitch (Turbo / Nx audience) - #71
Merged
Conversation
Replace the engineer-tone "here's what this is" README with a positioning-oriented one aimed at developers evaluating whether to move from Turborepo or Nx. The technical README continues to live in docs/README.md; this top-level file is for the first 30 seconds on the GitHub page. Structure: - Headline + tagline (Turbo-shape, smaller, faster). - One-curl install + a minimal config + 5 CLI examples. - Side-by-side comparison table across 12 axes. - "What you keep" — same cache model, same remote-cache wire, same filter DSL, same dependsOn micro-syntax. - "What's new" — TypeScript config with imports, strict output ownership, persistent tasks with regex readiness, built-in --profile / --summarize, single-binary install. - Speed paragraph — concrete reasons why (Bun startup, bun:sqlite, git ls-files, no daemon, Bun.spawn rusage, cache-hit replay). - Configurability paragraph — explicit-by-default sold as a feature. - Workspace + remote-cache config. - CLI essentials. - Migrating from Turbo (turbo.json -> vx.config.ts side-by-side). - One-paragraph architecture. - Docs index, Status, Development, License. Status section is honest about pre-alpha — semantics solid, the unfinished parts are operational (Windows, no npm publish, no managed remote cache).
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
Replace the engineer-tone "here's what this is" README with a positioning-oriented one aimed at developers evaluating whether to move from Turborepo or Nx. The technical reference docs continue to live under
docs/; this top-level file is for the first 30 seconds on the GitHub page.What the new README leads with
vx.config.ts+ 5 CLI examples — readable in under a minute.Sections
/v8/artifacts/wire, same--filterDSL, samedependsOnmicro-syntax, same--affectedsemantics.dist/old.jssurvives" angle), persistent tasks with regex readiness, built-in--profile/--summarize, single-binary install.bun:sqlite,git ls-files, no daemon,Bun.spawnresourceUsage, cache-hit replay = file copy + log replay).vx.workspace.ts+ theVX_REMOTE_CACHE_*env vars.docs/architecture.md.docs/modules/.Honesty notes
vx run ci) is conservative and matches the actual self-hosted workspace.Test plan
bun src/bin.ts run format— README formattedGenerated by Claude Code