Update of /project/net-nittin-irc/cvsroot/net-nittin-irc In directory common-lisp.net:/tmp/cvs-serv28287

Modified Files: README Log Message: move stuff to the user-guide

Date: Sun Nov 23 19:33:14 2003 Author: eenge

Index: net-nittin-irc/README diff -u net-nittin-irc/README:1.4 net-nittin-irc/README:1.5 --- net-nittin-irc/README:1.4 Sun Nov 23 17:39:15 2003 +++ net-nittin-irc/README Sun Nov 23 19:33:14 2003 @@ -1,39 +1,4 @@ net-nittin-irc: A Common Lisp interface to the client-part of the IRC -protocol; RFCs 2810, 2811 and 2812. - -Quick demo: - - * (require :net-nittin-irc) - - * (in-package :irc) - - * (setf connection (connect :nickname "mynick" - :server "irc.somewhere.org")) - - * (read-message-loop connection) - -That's it. Interrupt the read-message-loop and do: - - * (join connection "#lisp") - -etc. (look at command.lisp) to operate the library. After issuing a -command, you need to get back on the feed: - - * (read-message-loop connection) - -If you need to do something on every join, do: - - * (defun my-hook (message) - <do-something>) - - * (add-hook connection 'irc-join-message #'my-hook) - -and it will be run next time the library receives an irc-join-message. -For a full list of messages you can hook into, look at event.lisp. - -Your connection object will get updated by the library with regards to -users joining/parting channels, you joining/parting channels, etc. -Look at protocol.lisp's connection object for slots and methods. - -Erik Enge, erik@nittin.net +protocol; RFCs 2810, 2811 and 2812. See doc/user-guide.txt for more +information.