irc-go/README.md

# gIRC-Go

This is a bunch of self-contained packages that help with IRC development in Go. The package splits themselves are fairly similar to how things are split up in the [original Python version](https://github.com/DanielOaks/girc).

---

[![GoDoc](https://godoc.org/github.com/DanielOaks/girc-go?status.svg)](https://godoc.org/github.com/DanielOaks/girc-go)
[![Build Status](https://travis-ci.org/DanielOaks/girc-go.svg?branch=master)](https://travis-ci.org/DanielOaks/girc-go)
[![Coverage Status](https://coveralls.io/repos/DanielOaks/girc-go/badge.svg?branch=master&service=github)](https://coveralls.io/github/DanielOaks/girc-go?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/DanielOaks/girc-go)](https://goreportcard.com/report/github.com/DanielOaks/girc-go)

---

I'm aiming for this to become a client library all of its own. The best path to that is writing a bunch of useful, testable, self-contained packages that I'm able to wire together!

These packages are still in their early stages. Specifically, they're probably not as well-optimised as we'd like, and the interfaces exposed by them may not be final. For specific package details, view the documentation of that package.

An example bot that uses these packages can be found [here](https://gist.github.com/DanielOaks/cbbc957e8dba39f59d9e).

Packages:

* [**gircclient**](https://godoc.org/github.com/DanielOaks/girc-go/client): Very work-in-progress client library.
* [**ircfmt**](https://godoc.org/github.com/DanielOaks/girc-go/ircfmt): IRC format codes handling, escaping and unescaping.
* [**ircmap**](https://godoc.org/github.com/DanielOaks/girc-go/ircmap): IRC string casefolding.
* [**ircmatch**](https://godoc.org/github.com/DanielOaks/girc-go/ircmatch): IRC string matching (mostly just a globbing engine).
* [**ircmsg**](https://godoc.org/github.com/DanielOaks/girc-go/ircmsg): IRC message handling, raw line parsing and creation.
* [**ircutils**](https://godoc.org/github.com/DanielOaks/girc-go/ircutils): Useful utility functions and classes that don't fit into their own packages.

---

Also check out the eventmgr library [here](https://godoc.org/github.com/DanielOaks/eventmgr), which helps with event attaching and dispatching.
readme: Add client lib, and expand note 2016-02-15 15:25:08 +00:00			`# gIRC-Go`
Initial commit 2016-01-16 16:45:59 +00:00
Add more docs 2016-01-18 04:18:38 +00:00			`This is a bunch of self-contained packages that help with IRC development in Go. The package splits themselves are fairly similar to how things are split up in the [original Python version](https://github.com/DanielOaks/girc).`

readme: Add Build and Coverage badges 2016-01-17 08:50:59 +00:00			`---`

eventmgr: Move to its own repo, considering how much it pulls from ircreactor 2016-09-04 10:35:22 +00:00			`[![GoDoc](https://godoc.org/github.com/DanielOaks/girc-go?status.svg)](https://godoc.org/github.com/DanielOaks/girc-go)`
			`[![Build Status](https://travis-ci.org/DanielOaks/girc-go.svg?branch=master)](https://travis-ci.org/DanielOaks/girc-go)`
			`[![Coverage Status](https://coveralls.io/repos/DanielOaks/girc-go/badge.svg?branch=master&service=github)](https://coveralls.io/github/DanielOaks/girc-go?branch=master)`
			`[![Go Report Card](https://goreportcard.com/badge/github.com/DanielOaks/girc-go)](https://goreportcard.com/report/github.com/DanielOaks/girc-go)`
readme: Add Build and Coverage badges 2016-01-17 08:50:59 +00:00
			`---`

readme: Put build/coverage higher 2016-01-18 06:58:02 +00:00			`I'm aiming for this to become a client library all of its own. The best path to that is writing a bunch of useful, testable, self-contained packages that I'm able to wire together!`

readme: Add client lib, and expand note 2016-02-15 15:25:08 +00:00			`These packages are still in their early stages. Specifically, they're probably not as well-optimised as we'd like, and the interfaces exposed by them may not be final. For specific package details, view the documentation of that package.`
Note status better 2016-01-17 02:57:36 +00:00
Add more docs 2016-01-18 04:18:38 +00:00			`An example bot that uses these packages can be found [here](https://gist.github.com/DanielOaks/cbbc957e8dba39f59d9e).`
readme: Add link to tinybot 2016-01-17 03:00:11 +00:00
Note status better 2016-01-17 02:57:36 +00:00			`Packages:`

readme: Add client lib, and expand note 2016-02-15 15:25:08 +00:00			`* [gircclient](https://godoc.org/github.com/DanielOaks/girc-go/client): Very work-in-progress client library.`
ircfmt: Initial commit 2016-01-18 03:25:54 +00:00			`* [ircfmt](https://godoc.org/github.com/DanielOaks/girc-go/ircfmt): IRC format codes handling, escaping and unescaping.`
ircmap: Add initial version 2016-01-18 11:20:02 +00:00			`* [ircmap](https://godoc.org/github.com/DanielOaks/girc-go/ircmap): IRC string casefolding.`
Add ircmatch - globbing based on NFA 2016-09-17 08:19:12 +00:00			`* [ircmatch](https://godoc.org/github.com/DanielOaks/girc-go/ircmatch): IRC string matching (mostly just a globbing engine).`
Note status better 2016-01-17 02:57:36 +00:00			`* [ircmsg](https://godoc.org/github.com/DanielOaks/girc-go/ircmsg): IRC message handling, raw line parsing and creation.`
Add ircutils package 2016-11-28 06:27:27 +00:00			`* [ircutils](https://godoc.org/github.com/DanielOaks/girc-go/ircutils): Useful utility functions and classes that don't fit into their own packages.`
eventmgr: Move to its own repo, considering how much it pulls from ircreactor 2016-09-04 10:35:22 +00:00
			`---`

			`Also check out the eventmgr library [here](https://godoc.org/github.com/DanielOaks/eventmgr), which helps with event attaching and dispatching.`