Commit Graph
2 Commits
Author SHA1 Message Date
sneak 93ce3b210c README rewritten from scratch so a newcomer can follow it (closes #154, closes #155)
check / check (push) Canceled after 0s
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
2026-10-22 18:37:56 +00:00
sneak a0d2c21346 Add README, SPEC and tool evaluation, closes #1
Initial documents: what smallwebwaf is and why, the proposed feature list, the design spec with the rule file format and the open design questions, and the survey of existing tools.

Model: fable-5-1
2026-09-21 07:42:45 +00:00