From caa9429a74676529b4d775fcdfc9c9ddfaa1e9bf Mon Sep 17 00:00:00 2001 From: Alex Bramley Date: Sun, 6 Nov 2011 05:22:02 +0000 Subject: [PATCH] Update README. --- README.md | 13 ++++++++----- client/state_handlers.go | 1 - 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 151a558..ee76171 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,12 @@ This will connect to freenode and join `#go-nuts` by default, so be careful ;-) Synopsis: + import "flag" import irc "github.com/fluffle/goirc/client" + func main() { - c := irc.New("nick", "ident", "real name") - // Optionally, turn on debugging - c.Debug = true + flag.Parse() // parses the logging flags. + c := irc.New("nick", "ident", "real name", false, nil, nil) // Optionally, enable SSL c.SSL = true @@ -53,8 +54,10 @@ the messages from the IRC server, so you have to handle e.g. "332" for `RPL_TOPIC` to get the topic for a channel. The vast majority of handlers implemented within the framework deal with state -tracking of all nicks in any channels that the client is also present in. It's -likely that this state tracking will become optional in the near future. +tracking of all nicks in any channels that the client is also present in. These +handers are in `client/state_handlers.go`. State tracking is optional, and can +be enabled by passing `true` as the fourth argument to `client.New()`. This API +sucks and may change in the future. ### Misc. diff --git a/client/state_handlers.go b/client/state_handlers.go index fab0bfa..1ac1f2c 100644 --- a/client/state_handlers.go +++ b/client/state_handlers.go @@ -218,4 +218,3 @@ func (conn *Conn) h_671(line *Line) { line.Args[1]) } } -