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

Browse Source

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

...

This commit is contained in:

sneak

2026-10-22 22:29:53 +00:00

parent eafcc3fd73

commit 1dbe17e594

11 changed files with 1492 additions and 2344 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

README.md

+365 -2343

File diff suppressed because it is too large Load Diff