File: README.md

package info (click to toggle)
golang-sorcix-irc-dev 1.1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 132 kB
  • sloc: makefile: 3
file content (22 lines) | stat: -rw-r--r-- 907 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Go **irc** package

Please use the [**v2** branch][v2] for new projects!

[![GoDoc](https://godoc.org/gopkg.in/sorcix/irc.v1?status.svg)](https://godoc.org/gopkg.in/sorcix/irc.v1)

## Features
Package irc allows your application to speak the IRC protocol.

 - **Limited scope**, does one thing and does it well.
 - Focus on simplicity and **speed**.
 - **Stable API**: updates shouldn't break existing software.
 - Well [documented][Documentation] code.

*This package does not manage your entire IRC connection. It only translates the protocol to easy to use Go types. It is meant as a single component in a larger IRC library, or for basic IRC bots for which a large IRC package would be overkill.*

## Usage

Please use the [**v2** branch][v2] for new projects!

[Documentation]: https://godoc.org/gopkg.in/sorcix/irc.v1 "Package documentation by Godoc.org"
[v2]: https://github.com/sorcix/irc/tree/v2