Commit 318c8c16 by PLN (Algolia)

docs: README agents section — the three usage paths

parent 4556ff36
......@@ -41,6 +41,21 @@ stay manual checks. docs/research.md holds the clustering study;
docs/research-litreview.md (in progress) holds the literature review and
the falsifiable recommendations that will become catalog v3.
## Agents
Agents run buvard three ways, in order of friction:
```bash
npx buvard check . # after npm publish — no install at all
node bin/buvard.js check . # from a clone — zero dependencies, Node >= 18
buvard check . # global symlink (see install above)
```
`AGENTS.md` carries the project handoff for any agent; `SKILL.md` packages the
catalog as an agent skill: load it, run the linter, apply the findings by hand.
Hits are review candidates, never verdicts — the agent edits prose like an
editor, not like a filter.
## Skill
`SKILL.md` ships the catalog as an agent skill: load it, run the linter,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment