@skyf0xx/hedgehog 4.3.6 → 5.0.0

package/README.md

@@ -195,6 +195,17 @@ npx @skyf0xx/hedgehog update
 
 This refreshes the installed agents and skills in a specific repo (note, not vendor skills)
 
+### Installing a specific core
+
+Naming a core up front installs it with the shared payload. Without one, `init` installs the shared payload alone and leaves the choice to planning intake, where `planner` selects a core — `full-stack-app`, `landing-page`, or one it designs for the project:
+
+``` bash
+npx @skyf0xx/hedgehog init --core full-stack-app
+npx @skyf0xx/hedgehog cores list   # every core this release can install, and what each is for
+```
+
+Each named core ships as its own npm package (`@skyf0xx/hedgehog-core-full-stack-app`, `@skyf0xx/hedgehog-core-landing-page`); `init` fetches the version `src/registry/cores.json` names and caches it locally, so a repeat install on the same version needs no network.
+
 ## Why Hedgehog
 
 Most AI coding tools improve prompting.
@@ -216,6 +227,15 @@ Hedgehog uses a fixed stack and build order for each core. The tooling enforces
 
 See [ARCHITECTURE.md](ARCHITECTURE.md) for the full design.
 
+## Authoring a new core
+
+A core is an npm package carrying a pre-built, pre-verified workspace plus the agents and skills that build it. The package contract, at the package root:
+
+- `hedgehog-core.yaml` — the manifest naming the core (matching its registry entry), its language, and where each contributed piece lives in the package: `workspace/` (the scaffold, omitted by a core that scaffolds nothing), `CLAUDE.core.md` (fills the installed `CLAUDE.md` shell's core section), `agents/<name>.md`, `skills/<name>/`, and any `vendor_skills/<name>/`. Its `engine` key states the engine line the core's agents and skills are written against, as a caret range over a three-part version (`engine: "^5.0.0"`); an older CLI refuses the core rather than landing a payload it cannot drive.
+- `core.yaml` — the layer sequence and per-layer verify commands, in the same shape `src/db/core.mjs` loads for an authored core.
+
+Adding the package to the CLI's `init` menu is one entry in `src/registry/cores.json`: the package name, the version range to resolve, an install flag, and the `selects_when` prose. That entry owns the selection prose — `planner` reads it in Phase 0, before any core package is fetched — so the manifest leaves it out; a `selects_when` in a manifest is never read.
+
 ## Credits
 
 Hedgehog uses [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD)