From 15af2256059a9866e3b34a351fc4f6c0c039598b Mon Sep 17 00:00:00 2001 From: Jack Felke Date: Tue, 17 Mar 2026 20:30:16 -0700 Subject: [PATCH] docs: add init wizard step to Quick Start, include examples/ in npm package - Added 'Optional: Initialize project config' section between Option B and C showing users how to run the setup wizard or manually copy example configs - Added examples/ to package.json files array so npm installs include the .preflight/ example configs for manual copying - Makes the zero-to-configured flow clearer for all install methods --- README.md | 14 ++++++++++++++ package.json | 1 + 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 6d03f5d..2a97dd0 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,20 @@ Add to your project's `.mcp.json`: Restart Claude Code. The tools activate automatically. +### Optional: Initialize project config + +After adding the MCP server (any option), run the setup wizard in your project directory to create a `.preflight/` config: + +```bash +# Interactive wizard — sets up .mcp.json and .preflight/ config +npx preflight-dev + +# Or manually copy the example configs: +cp -r node_modules/preflight-dev/examples/.preflight .preflight +``` + +The `.preflight/` directory is optional — preflight works with sensible defaults out of the box. But if you want to customize triage rules, add related projects for cross-service awareness, or tune thresholds, this is where you do it. Commit it to your repo so the whole team shares the same config. + ### Option C: npm (global) ```bash diff --git a/package.json b/package.json index 628fc13..751c6bf 100644 --- a/package.json +++ b/package.json @@ -41,6 +41,7 @@ "src/", "bin/", "dist/", + "examples/", "README.md", "LICENSE" ],