dunno

[infobot.git] / README

diff --git a/README b/README
index 72e70f26b432a5f7693eed444de1fe28f4af2e57..4629cda7a63184c3a0e6553c7d84bae39b38590d 100644 (file)
--- a/README
+++ b/README
@@ -1,41 +1,38 @@
-infobot v1.5.0
---------------
+# $Id$
+
+                                 -------------
+                                 -- Infobot --
+                                 -------------
 
 INTRODUCTION
        This bot is based upon blootbot, which was a fork of infobot-0.44.2 by
 Kevin Lenzo <lenzo@cs.cmu.edu>, which is now officially rebranded back to
 infobot!  The basis of infobot is still there but _many_ wild features have
-been added.  Along the way, a couple of typos were spotted in the original
-infobot source and fixed in this version. Without infobot, there would be no
-blootbot, and thus no infobot again, so all thanks to kevin for bringing
-infobot in the first place.
+been added.  Along the way, many issues were spotted in the original
+infobot source and fixed in this version. Many new bugs have been added as well.
+Thanks to kevin for bringing infobot in the first place.
 
 
 FEATURES
        * Additional information stored with factoids. (factinfo)
-       * Wide range of statistics for Bot, Factoids, IRC, Debian.
+       * Wide range of statistics for Bot, Factoids, IRC, Debian
          (status, factstats, ircstats, chanstats, cmdstats)
-       * Advanced topic management. (the first cool feature)
-       * Improved factoid search, allowing search by key or value.
+       * Advanced topic management
+       * Improved factoid search, allowing search by key or value
        * Freshmeat support (freshmeat.net)
-       * Debian Contents and Packages, search and info.
-       * ChanServ/NickServ (OPN) support.
-       * WWW-Search (eg: google for BLAH)
-       * Slashdot, Kernel and Freshmeat auto-update announcements.
-       * Units conversion (provided by external module, Units-Module)
+       * Debian Contents and Packages, search and info
+       * ChanServ/NickServ (freenode) support
+       * WWW-Search (eg: google for BLAH) (NOTE: Currently broken)
+       * Slashdot, Kernel, RSS and Freshmeat auto-update announcements
+       * Units conversion (provided by external "units" program)
 
 
 DESIGN
-       - Modularity. Ability to disable IRC or Factoid support.
+       - Modularity. Ability to disable IRC or Factoid support
        - Funky pseudo Module autoloader support
-       - Eleet Forker() function
-
-
-IMPROVEMENTS
-       * log file is not opened and closed for each line of data
-               => unblocked logging is used.
-       * seen data is not flushed for each public message on IRC
-               => caching and flushing over an interval is used.
+       - Modules called via Forker() to avoid blocking
+    - Non blocking logs
+    - Seen data periodicaly flushed for efficiency
 
 
 HISTORY
@@ -75,10 +72,6 @@ However, these people do not realize the potential of open wingates.
 test all modifications properly (and extensively).  Suggestions are
 welcomed.
 
-       gp@OPN is currently working on a C version of infobot or
-blootbot, not based on the above source base.  Core factoid code and
-mysql support works - but that is it.
-
 
 MODIFICATIONS
        All modifications are that of the blootbot author unless otherwise
@@ -124,11 +117,11 @@ through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
 
 
 UNTESTED:
-       - user statistics shown by 'seen'. bug in this?
+       - user statistics shown by 'seen'.
        - User Information Services.
        - new wingate caching/file-read code.
        - disabling IRC/factoid support code.
-       - PG supports need to be worked and thoroughly tested.
+       - PGSql support needs to be more thoroughly tested.
 
 
 CONTRIBUTIONS
@@ -137,13 +130,13 @@ modifications, aswell as giving suggestions and ideas in the early
 development stages. Bashing of modifications courtesy of larne, irq, lilo
 and \broken.
 
-       mu@OPN for the SAR (=~ s///) and Topic history patch.
+       mu@freenode for the SAR (=~ s///) and Topic history patch.
 
        someone emailed me a patch to fix up telnet but I accidently
 deleted the message together with the patch after replying to the guy. I
 hope to get that same guy to re-send me the patch...
 
-       MbM@OPN sent a patch to clean up behaviour of factoids
+       MbM@freenode sent a patch to clean up behaviour of factoids
 (adding, removing, modifying).  Thanks.