mirror/goirc
1
0
Fork 0
mirror of https://github.com/fluffle/goirc synced 2025-09-05 16:33:19 +00:00
Code Issues Releases Wiki Activity

Update README and example client once more.

Browse source
This commit is contained in:
Alex Bramley 2011-11-09 22:06:54 +00:00
parent 8239bc4b6e
commit 80d8cd4ea7
2 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -23,7 +23,7 @@ Synopsis:
func main() {
flag.Parse() // parses the logging flags.
c := irc.New("nick", "ident", "real name", false, nil, nil)
c := irc.SimpleClient("nick")
// Optionally, enable SSL
c.SSL = true
@ -55,9 +55,11 @@ the messages from the IRC server, so you have to handle e.g. "332" for
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. 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.
handers are in `client/state_handlers.go`. State tracking is optional, disabled
by default, and can be enabled and disabled by calling `EnableStateTracking()`
and `DisableStateTracking()` respectively. Doing this while connected to an IRC
server will probably result in an inconsistent state and a lot of warnings to
STDERR ;-)
### Misc.