docs: lead README with Vite plugin path#8
Merged
kevinccbsg merged 1 commit intomainfrom May 8, 2026
Merged
Conversation
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>
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
twdRemote()tovite.config.ts+npx twd-relay run. The manualcreateBrowserClientsnippet is gone from the top.autoConnect: false. Includes the inline double-client warning.--max-test-durationflag added to the CLI flags table — it was supported by the CLI but missing from the docs.No code changes. Net: 139 insertions / 111 deletions, README only.
Test plan
[CLI run command](#cli-run-command)anchor inside Quick start resolves correctly on GitHub.src/browser/types.tslink points at the right file.🤖 Generated with Claude Code