summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2021-09-06 17:35:34 -0400
committerJune McEnroe <june@causal.agency>2021-09-06 17:35:34 -0400
commit22b58b9749be60a90e3b51284d01698976d0cfaf (patch)
tree1afab47bb610918848ddbe7fd022b18a973da2d9
parentDocument DIAGNOSTICS (diff)
downloadpounce-2.5.tar.gz
pounce-2.5.zip
Explain what pounce does and some of how it works in README 2.5
That opening paragraph was severely lacking for a README.
Diffstat (limited to '')
-rw-r--r--README.732
1 files changed, 26 insertions, 6 deletions
diff --git a/README.7 b/README.7
index 7997a49..2ad9f67 100644
--- a/README.7
+++ b/README.7
@@ -1,4 +1,4 @@
-.Dd May 27, 2021
+.Dd September  6, 2021
 .Dt README 7
 .Os "Causal Agency"
 .
@@ -9,13 +9,33 @@
 .Sh DESCRIPTION
 .Xr pounce 1
 is a multi-client, TLS-only IRC bouncer.
-It takes a simple approach,
-using a multiple-consumer ring buffer
-and the IRCv3
-.Sy server-time
-extension to communicate with clients.
+It maintains a persistent connection
+to an IRC server,
+acting as a proxy and buffer
+for a number of clients.
+When a client connects,
+any messages received
+since it last disconnected
+will be relayed to it.
+Unlike some other bouncers,
+.Nm
+uses a single buffer
+for all IRC messages,
+which acts as a queue
+from which each client
+reads messages independently.
 .
 .Pp
+.Nm
+speaks regular modern IRC
+to both servers and clients,
+using the
+.Sy server-time
+extension to indicate
+when messages originally occurred.
+Clients identify themselves to
+.Nm
+by their IRC usernames.
 See
 .Xr QUIRKS 7
 for notes on connecting
esse 2019-06-05global: make 'char *path' const where possibleChristian Hesse 2019-05-20ui-shared: restrict to 15 levelsJason A. Donenfeld 2019-02-23ui-diff,ui-tag: don't use htmlf with non-formatted stringsChris Mayo 2019-02-23ui-ssdiff: resolve HTML5 validation errorsChris Mayo 2019-01-03filters: migrate from luacrypto to luaosslJason A. Donenfeld 2019-01-02ui-shared: fix broken sizeof in title setting and rewriteJason A. Donenfeld 2018-12-09git: update to v2.20.0Christian Hesse 2018-11-25ui-blame: set repo for sbJason A. Donenfeld 2018-11-25auth-filter: pass url with query string attachedJason A. Donenfeld 2018-11-21git: use xz compressed archive for downloadChristian Hesse 2018-10-12git: update to v2.19.1Christian Hesse 2018-09-11ui-ssdiff: ban strcat()Christian Hesse 2018-09-11ui-ssdiff: ban strncpy()Christian Hesse 2018-09-11ui-shared: ban strcat()Christian Hesse 2018-09-11ui-patch: ban sprintf()Christian Hesse 2018-09-11ui-log: ban strncpy()Christian Hesse 2018-09-11ui-log: ban strcpy()Christian Hesse 2018-09-11parsing: ban sprintf()Christian Hesse 2018-09-11parsing: ban strncpy()Christian Hesse 2018-08-28filters: generate anchor links from markdownChristian Hesse 2018-08-03Bump version.Jason A. Donenfeld 2018-08-03clone: fix directory traversalJason A. Donenfeld 2018-08-03config: record repo.snapshot-prefix in the per-repo configKonstantin Ryabitsev