1 files changed, 68 insertions, 31 deletions
diff --git a/README.7 b/README.7
index 241627c..b15a8e2 100644
--- a/README.7
+++ b/README.7
@@ -1,4 +1,4 @@
-.Dd August 30, 2020
+.Dd October 21, 2023
 .Dt README 7
 .Os "Causal Agency"
 .
@@ -9,11 +9,38 @@
 .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.2
+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 communicate with clients.
+extension to indicate
+when messages originally occurred.
+Clients identify themselves to
+.Nm
+by their IRC usernames.
+See
+.Xr QUIRKS 7
+for notes on connecting
+.Nm
+with particular networks and clients.
 .
 .Sh RATIONALE
 As a former
@@ -48,22 +75,26 @@ provided by either
 .Lk https://git.causal.agency/libretls/about LibreTLS
 (for OpenSSL)
 or by LibreSSL.
-It primarily targets
-.Fx ,
-where it is sandboxed with
-.Xr capsicum 4 ,
+.Nm
+and
+.Sy libtls
+may be packaged for your system.
+Check the Repology pages for
+.Lk https://repology.org/project/pounce/versions pounce
 and
+.Lk https://repology.org/project/libretls/versions libretls .
+.
+.Pp
+.Nm
+primarily targets
 .Ox ,
 where it is sandboxed with
 .Xr pledge 2
 and
 .Xr unveil 2 .
+.Fx ,
 Linux and macOS
 are also supported.
-On
-.Ox ,
-configure with
-.Fl \-mandir=/usr/local/man .
 .Bd -literal -offset indent
 \&./configure
 make all
@@ -96,30 +127,32 @@ PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure
 .
 .Pp
 On
-.Fx
-and
 .Ox
 the recommended way to run
 .Nm
 is with the process supervisor
-.Lk https://git.causal.agency/catsit catsit .
+.Lk https://git.causal.agency/kitd kitd .
 .
 .Ss Additional Components
 Additional functionality can be provided
 by special-purpose clients connected to
 .Nm .
-.Bl -bullet
-.It
-Logging can be provided by
-.Lk https://git.causal.agency/litterbox litterbox .
-.It
-Push notifications for the Palaver IRC app
-can be provided by
-.Nm pounce-palaver ,
-located in the
-.Pa contrib/palaver
-directory.
-It additionally requires
+.Bl -inset
+.It Lk https://git.causal.agency/litterbox litterbox
+provides logging and search.
+.It Xr pounce-notify 1
+provides notifications
+by running an external command.
+Configure with
+.Fl \-enable-notify
+to build.
+.It Xr pounce-palaver 1
+provides push notifications
+for the Palaver IRC app.
+Configure with
+.Fl \-enable-palaver
+to build.
+Requires
 .Sy libcurl
 and
 .Sy libsqlite3 .
@@ -141,8 +174,6 @@ remote client connections
 state shared between clients
 .It Pa ring.c
 buffer between server and clients
-.It Pa cert.c
-sandboxed certificate reloading
 .It Pa config.c
 .Xr getopt_long 3 Ns -integrated
 configuration parsing
@@ -159,6 +190,12 @@ Contributions in any form can be sent to
 .Aq Mt list+pounce@causal.agency .
 For sending patches by email, see
 .Aq Lk https://git-send-email.io .
+Mailing list archives are available at
+.Aq Lk https://causal.agency/list/pounce.html .
+.
+.Pp
+Monetary contributions can be
+.Lk https://liberapay.com/june/donate "donated via Liberapay" .
 .
 .Sh SEE ALSO
 .Xr calico 1 ,
@@ -169,7 +206,7 @@ Central logging with full-text search:
 .Lk https://git.causal.agency/litterbox "litterbox"
 .
 .Rs
-.%A June Bug
+.%A June McEnroe
 .%T IRC Suite
 .%U https://text.causal.agency/010-irc-suite.txt
 .%D June 19, 2020