@sightmap/sightmap 0.3.1 → 0.5.0

package/README.md

@@ -182,6 +182,37 @@ Codes are stable, kebab-case, and exported as constants:
 
 Renames require an SEP. Future SDK ports (Python, Go) MUST emit identical codes for the same conditions.
 
+## Initialize a project
+
+For a new adopter, the fastest path from zero to a working Sightmap loop is:
+
+```sh
+npx @sightmap/sightmap init
+```
+
+This detects your framework (React/Next/Vite/RR7), the coding-agent
+harness(es) in use (Claude Code, Codex, Cursor, OpenCode), and any
+Sightmap-aware browser MCP already installed (Subtext today). It then runs
+framework setup (adapter install, `<SightmapProvider>` codemod, codegen) and
+offers two install paths:
+
+- **Plugin** (recommended): two copy-paste commands per host. Skills, hooks,
+  MCP — all together.
+- **Manual**: writes MCP config + copies skills/hooks into this repo.
+
+Pass `--yes` to skip all prompts and accept defaults. Other flags:
+
+```
+--plugin / --manual         Force install path
+--host <names>              Comma-separated: claude-code,codex,cursor,opencode
+--with-browser              Force bundled Playwright + sightmap_* browser tools
+--curate-only               Force curation-only MCP
+--no-codegen                Skip sightmap-react gen
+--no-provider               Skip <SightmapProvider> codemod
+```
+
+See `docs/superpowers/specs/2026-05-11-sightmap-init-design.md` for the full design.
+
 ## License
 
 MIT.