From e88e889e64f53e51a99f1acb8e4f02a5a78b8a83 Mon Sep 17 00:00:00 2001 From: Jack Felke Date: Fri, 20 Mar 2026 08:01:13 -0700 Subject: [PATCH] docs: promote init wizard as recommended Quick Start option The interactive setup wizard (npx preflight-dev init) was buried in a footnote under Option C, despite being the most user-friendly onboarding path. Moved it to Option A with a clear description of what it does. Renumbered remaining options accordingly. --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6d03f5d..9472e34 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,18 @@ The pattern is always the same: vague prompt → Claude guesses → wrong output ## Quick Start -### Option A: npx (fastest — no install) +### Option A: Interactive setup (recommended) + +The init wizard creates your `.mcp.json` and `.preflight/` config in one step: + +```bash +cd /path/to/your/project +npx preflight-dev init +``` + +It walks you through profile selection (minimal/standard/full), embedding provider, and config directory setup — then writes everything for you. Just restart Claude Code when it's done. + +### Option B: One-liner (fastest — no wizard) ```bash claude mcp add preflight -- npx -y preflight-dev-serve @@ -90,7 +101,7 @@ claude mcp add preflight \ -- npx -y preflight-dev-serve ``` -### Option B: Clone & configure manually +### Option C: Clone & configure manually ```bash git clone https://github.com/TerminalGravity/preflight.git @@ -115,7 +126,7 @@ Add to your project's `.mcp.json`: Restart Claude Code. The tools activate automatically. -### Option C: npm (global) +### Option D: npm (global) ```bash npm install -g preflight-dev