1
0
Fork 0

docs(readme): add concrete 'What it protects against' catalogue; split limitations

Answers the gap that the README said what it does NOT stop (a long limitations
section) but never plainly listed what it DOES. Add a 'What it protects against'
section high up: attack classes grouped by OWASP anchor (LLM01 injection + 83
lexicon classes + carriers, LLM02 egress, LLM05 EchoLeak, LLM06 agency, LLM10
fail-secure, OKF T1-T6, container front-end), each driven by a live coverage-matrix
payload. Move the full honest-limitations list to docs/LIMITATIONS.md; README keeps
a high-impact summary + link. Net: protection and limits read in balance, 261 -> 216
lines. Coverage 126/126 and 522 tests unchanged; every class listed is real.
This commit is contained in:
Kjell Tore Guttormsen 2026-07-15 19:09:04 +02:00
commit 3dda1f68fa
3 changed files with 145 additions and 96 deletions

View file

@ -34,9 +34,13 @@ This is the real-case validation gate ahead of a v1.0 freeze.
(`import_bundle` mode-b), how to verify (coverage matrix), how to depend
(stdlib-only core), and a checklist for *when/where* to wire it.
- README rewritten to lead with the write-time trust-boundary framing, add a
first-class **OKF / LLM-wiki support (shipped)** section for `import_bundle`, and
correct the test badge (357 → 522). Every claim verified against the code; all
honest-limitations items retained.
first-class **OKF / LLM-wiki support (shipped)** section for `import_bundle`, a
concrete **What it protects against** catalogue (attack classes grouped by OWASP
anchor, driven by the coverage matrix), and correct the test badge (357 → 522).
Every claim verified against the code.
- `docs/LIMITATIONS.md` — the full honest-limitations list (15 items + the four
documented gaps + out-of-scope) moved out of the README, which now carries a
high-impact summary + link, so protection and limits read in balance.
## [0.2.0] — 2026-07-06