Documentation improvements.

diff --git a/README b/README
index 844a4e4fd27e4525314f70011307867583503a6e..f4d931c1c9a48fa49136c1fed6a776249d4143fd 100644 (file)
--- a/README
+++ b/README
@@ -19,7 +19,7 @@ Due to the abrupt death of cia.vc on September 24 2012 the
 initial release of this software was a bit rushed.  See the file
 BUGS for known problems.
 
-Please read the file hacking.txt before modifying this code.
+Please read the files security.txt and hacking.txt before modifying this code.
 
                                                Eric S. Raymond
                                                August 2012

diff --git a/install.txt b/install.txt
index 9850f06d71ca60d70d174b2a4fcb47e21340c587..f7f73f6bfe702c9869ad69b9f1ca3b510d4409f9 100644 (file)
--- a/install.txt
+++ b/install.txt
@@ -5,6 +5,17 @@ such as SourceForge, GitHub, Gitorious, Gna, and Savannah.  This
 file explains the theory of operation, how to install the code,
 and how to test it.
 
+== Theory of operation ==
+
+irkerhook.py creates JSON notification requests and ships them to
+irkerd's listener socket.  irkerd run as a daemon in order to maintain
+all the client state required to post multiple notifications while generating
+minimum of join/leave messages (which, from the point of view of
+humans watching irkerd's output, are mere spam).
+
+See the security.txt document for a detailed discussion of security
+and DoS vulnerabilities related to irker.
+
 == Installing irker ==
 
 irker needs to run constantly, watching for TCP and UDP traffic on
@@ -17,6 +28,12 @@ You will need to have Jason Coombs's irc library where Python can see
 it.  See <http://pypi.python.org/pypi/irc/>; use version 3.0, not the
 older code from SourceForge.
 
+For higher performance, also install the eventlet library from
+<http://pypi.python.org/pypi/eventlet/>.  This merges in a cooperative
+threading implementation that is faster and has much lower space
+overhead than system threads, making irkerd more resistant to
+potential DoS attacks.
+
 == Installing irkerhook.py ==
 
 irkerhook.py should be called from the post-commit hook of each 
@@ -53,7 +70,3 @@ mine stuff out of.
 Go to a project repo and call irkerhook.py as indicated above while
 watching the freenode #commits channel.
  
-== Security considerations ==
-
-See the security.txt document for a detailed discussion of security
-and DoS vulnerabilities related to irker.