Rewrite README.md sentence by sentence (closes #190)

Browse Source

Rewrite the README from scratch as the user guide and the reference
for the HTTP API and the IRC listener, checked statement by statement
against the code. It leads with what the program is and how to use
it, puts every setting in a reference section and ends with
development and testing. Project history, plans and unbuilt designs
(federation, signing, PUBKEY, Postgres) are gone, as are all tables.
Each command now documents the event the server sends, the KICK event
included. Channel names, like nicks, compare by exact case, and the
text says so. The DBURL section no longer suggests an in-memory
database.

Closes #190.

Model: fable-5-1

...

This commit is contained in:

clawbot

2026-10-27 13:13:17 +00:00

parent ecf47c37f5

commit 0189a7e16f

1 changed files with 1623 additions and 3241 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

+1623 -3241

File diff suppressed because it is too large Load Diff