README rewritten from scratch so a newcomer can follow it (closes #154, closes #155) #157

Open
clawbot wants to merge 1 commits from readme-rewrite-155 into next
1 Commits
Author SHA1 Message Date
sneak 91438f54da README rewritten from scratch so a newcomer can follow it (closes #154, closes #155)
check / check (push) Waiting to run
The old README opened with project history and one list of a hundred
settings. The new one leads with what smallwebwaf is, what it protects
against, how to build and deploy it, what happens to a request, the
settings most deployments touch, how to check it works, the entrypoints,
the rationale and the design, as REPO_POLICIES.md requires. The reference
lists, every setting, the rule file format, the endpoints, the request
log's fields, the alert events, the metrics, the state files, the image
and the gitea notes, move to files under docs/, each linked from the
README, with SPEC.md as the one place for behaviour. Every statement was
checked against the code on next.

Model: fable-5-1
2026-10-22 21:56:16 +00:00