Author SHA1 Message Date
sneak 9af927c8cf README reworked after review: every finding fixed, every sentence reread
check / check (push) Waiting to run
The eighteen findings of the review on the PR are fixed: statements the
code does not bear out, the stacked "a client a blocklist lists" form,
late verbs, sentences over thirty words, comma chains where bullets
belong, sentences a newcomer reads twice, and one project-plan remark.
Every other sentence was reread against the same rules, and the ones
that still put the object before the subject were rewritten.

Model: fable-5-1
2026-10-22 19:13:56 +00:00
sneak 93ce3b210c 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 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
+1524 -2207
View File
File diff suppressed because it is too large Load Diff