From f4f4ec9aebb385c4250e3a508d71f000fe932cdb Mon Sep 17 00:00:00 2001
From: Neale Pickett <neale@woozle.org>
Date: Thu, 6 Jan 2011 22:21:32 -0700
Subject: [PATCH] Update README a little

---
 README | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/README b/README
index fb7ba96..b21dfd9 100644
--- a/README
+++ b/README
@@ -1,7 +1,51 @@
 bot
 ===
 
-If djb ever wrote an IRC bot, it might look something like this.
+This is a suite of simple programs which allow you to write an IRC bot.
+It is based on the Unix principle that one program should do one thing,
+and makes extensive use of pipes, child processes, and passing of file
+descriptors.
+
+Unless you are a seasoned Unix programmer or are willing to become one,
+this is not the bot you're looking for.
+
+
+dispatch
+--------
+
+Reads lines from stdin (or fd 6).  Each line causes a fork and exec of a
+specified program; the line is sent as the last argument.  Any output
+from children is passed through to stdout (or fd 7), optionally rate
+limited.  A fifo can optionally be specified on the command line;
+anything written to it is treated identically to child output.
+
+
+irc
+---
+
+Parses its last argument as a line from IRC.  Determines prefix,
+command, sender, forum (channel or user), and text; then invokes a
+specified program with these as arguments.  Also responds to server
+pings as a convenience.
+
+
+bot
+---
+
+Given nickname $nick, creates $nick.fifo, logs into IRC as $nick, and
+passes control to dispatch -> irc -> $nick-handler.
+
+
+Putting it all together
+=======================
+
+A full chain of programs would look something like
+
+    tcpclient -> bot -> dispatch -> handler
+
+and would be invoked as
+
+    $ tcpclient irc.host.org 6667 ./bot cobalt
 
 
 Author