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

Browse Source

The old README opened with a narrative of milestones and one sentence
listing every feature, and gave its settings as one list of a hundred
entries. The new one leads with what smallwebwaf is, what it protects
against, how to build and deploy it, what happens to a request, what a
refused visitor and the operator see, and how to check it works. The
settings follow, grouped by topic, each with its default and what a bad
value does. The rest is reference: bans, rule files, the Core Rule Set,
the admin endpoints, the request log, alerts, metrics, state files and
the reputation sources. Every statement was checked against the code on
next; nothing describes unbuilt behaviour. Short sentences, bulleted
lists in place of comma chains, no tables, every identifier in
backticks, no project history.

Model: fable-5-1

...

This commit is contained in:

sneak

2026-10-22 18:37:56 +00:00

parent eafcc3fd73

commit 93ce3b210c

1 changed files with 1442 additions and 2205 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

+1442 -2205

File diff suppressed because it is too large Load Diff