Skip to content

docs: lead README with Vite plugin path#8

Merged
kevinccbsg merged 1 commit intomainfrom
docs/readme-vite-first
May 8, 2026
Merged

docs: lead README with Vite plugin path#8
kevinccbsg merged 1 commit intomainfrom
docs/readme-vite-first

Conversation

@kevinccbsg
Copy link
Copy Markdown
Member

Summary

  • Vite Quick start is now the first content section — install + add twdRemote() to vite.config.ts + npx twd-relay run. The manual createBrowserClient snippet is gone from the top.
  • Manual setup demoted to a clearly-framed "non-Vite, or opting out" section below operational reliability. Targets Webpack / Angular CLI / Rollup / esbuild / Rspack consumers and Vite users who explicitly set autoConnect: false. Includes the inline double-client warning.
  • Failures recap promoted to its own subsection under "Operational reliability" (was a one-line note at the bottom of CLI run command).
  • --max-test-duration flag added to the CLI flags table — it was supported by the CLI but missing from the docs.
  • Architecture and protocol moved below the practical sections — they're reference, not need-to-know.

No code changes. Net: 139 insertions / 111 deletions, README only.

Test plan

  • Render the PR README on GitHub and confirm the "Quick start (Vite)" section is the first thing readers see after the tagline.
  • Verify the [CLI run command](#cli-run-command) anchor inside Quick start resolves correctly on GitHub.
  • Verify the manual setup section's src/browser/types.ts link points at the right file.

🤖 Generated with Claude Code

Reorganize so Vite is the recommended quick start (one-line plugin
install) and the manual createBrowserClient snippet sits in a
"non-Vite or opting out" section below operational reliability.
Promote failures recap to its own subsection and add the
--max-test-duration flag to the CLI table.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kevinccbsg kevinccbsg merged commit 821bf99 into main May 8, 2026
5 checks passed
@kevinccbsg kevinccbsg deleted the docs/readme-vite-first branch May 8, 2026 20:39
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