create-turbo-wizard 0.1.0 → 0.1.2

package/README.md

@@ -17,29 +17,46 @@ pnpm create turbo-wizard@latest --name acme-site \
   --modules ui sections seo forms --yes
 ```
 
+With npm, put `--` before the first flag: `npm create turbo-wizard@latest -- --name …`
+
 Build a stack visually at **[turbo-wizard.vercel.app/new](https://turbo-wizard.vercel.app/new)** —
 it previews the exact file tree and hands you the command.
 
-## What you pick
-
-| Axis | Options |
-| --- | --- |
-| Frontend | `astro`, `next` |
-| Content | `sanity`, `markdown`, `none` |
-| Package manager | `pnpm`, `bun`, `npm` |
-| Preset | `vanilla`, `whole-hog` |
+## Flags
+
+| Flag | Choices | Default |
+| --- | --- | --- |
+| `--name` | lowercase letters, digits, `.` `_` `-` | prompted, else `my-app` |
+| `--frontend` | `astro`, `next` | prompted, else `next` |
+| `--content` | `sanity`, `markdown`, `none` | `none` |
+| `--package-manager` | `pnpm`, `bun`, `npm` | `pnpm` |
+| `--modules` | space-separated ids, table below | none |
+| `--preset` | `vanilla`, `whole-hog` | — |
+| `--deploy` | `node`, `vercel` | `node` |
+| `--dir` | where to write the project | `./<name>` |
+| `--install` | install dependencies after scaffolding | `false` |
+| `--git` | `git init` and a first commit | `false` |
+| `--yes` | skip prompts, take defaults | `false` |
+
+Presets are shorthand: `vanilla` is no content source and no modules; `whole-hog` is
+Sanity, every module, and both experimental Next flags (`--cache-components`,
+`--react-compiler`). Explicit flags win over the preset.
+
+`--deploy` matters only for an Astro project with a server route (the `forms` module
+adds one): it decides whether the SSR adapter is `@astrojs/node` or `@astrojs/vercel`.
+Next projects ignore it.
 
 ## Modules
 
 | Module | What it adds |
 | --- | --- |
 | `ui` | shadcn/ui and Tailwind v4 in a shared `@workspace/ui` package |
-| `sections` | Hero, features, pricing, testimonials, FAQ, CTA — static, no client JS |
+| `sections` | Hero, features, logo cloud, pricing, testimonials, FAQ, CTA — static, no client JS. Requires `ui` |
 | `seo` | Metadata, sitemap, robots, generated OG images |
 | `forms` | A contact form and API route sharing one zod schema |
 | `posthog` | Product analytics, opted out until you opt in |
-| `algolia` | Search |
-| `llms` | An `llms.txt` so models can read your site |
+| `algolia` | Site search with InstantSearch |
+| `llms` | `llms.txt` and a `.md` mirror of each page, so models can read your site |
 | `vitest` | Unit tests |
 | `e2e` | Playwright |
 | `github-ci` | A CI workflow |
@@ -61,17 +78,33 @@ The `ui` module lays `packages/ui` out exactly the way `shadcn init --monorepo`
 `npx shadcn@latest add dialog` works in a generated project without any further setup. You
 get shadcn's whole catalogue, not a fork of it.
 
+With `sanity`, the Studio is its own app under `apps/studio`, not a route inside the site.
+It's Vite, so Next and Astro projects get the identical one. The schema ports Roboto
+Studio's `turbo-start-sanity` down to the type and field names, so components and GROQ from
+that repo drop straight in. Seed the dataset and the home page renders fully composed across
+all seven blocks.
+
 Every combination is verified for real before release — scaffolded, installed, built, served,
 and every page probed — one Docker container per combination.
 
 ## Also an MCP server
 
-```bash
-create-turbo-wizard mcp
+The same binary speaks MCP over stdio, so an agent can scaffold a project itself:
+
+```json
+{
+  "mcpServers": {
+    "turbo-wizard": {
+      "command": "npx",
+      "args": ["-y", "create-turbo-wizard", "mcp"]
+    }
+  }
+}
 ```
 
-Exposes the same generator over stdio, so an agent can scaffold a project itself.
-`tw_create` never installs dependencies.
+Four tools: `tw_guidance` describes the options, `tw_schema` returns the config's JSON
+Schema, `tw_plan` previews the file paths a config would generate without writing, and
+`tw_create` scaffolds to disk. `tw_create` never installs dependencies.
 
 ## Requires