irc-go/README.md

1.6 KiB

ergochat/irc-go (mirror)

These are libraries to help in writing IRC clients and servers in Go, prioritizing correctness, safety, and IRCv3 support. They are not fully API-stable, but we expect any API breaks to be modest in scope.


GoDoc Build Status Coverage Status Go Report Card


Packages:

  • ircmsg: IRC message handling, raw line parsing and creation.
  • ircreader: Optimized reader for \n-terminated lines, with an expanding but bounded buffer.
  • ircevent: IRC client library (fork of thoj/go-ircevent).
  • ircfmt: IRC format codes handling, escaping and unescaping.
  • ircutils: Useful utility functions and classes that don't fit into their own packages.

For a relatively complete example of the library's use, see slingamn/titlebot.