ircd.chat/irc-go
10
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Add more docs

Browse Source
This commit is contained in:
Daniel Oaks 2016-01-18 14:18:38 +10:00
parent 4d8f579c43
commit 887ba768d3
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,8 @@
# gIRC-go
This is an IRC library for Go, pretty similar to the [original Python version](https://github.com/DanielOaks/girc).
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).
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!
---
@ -8,9 +10,9 @@ This is an IRC library for Go, pretty similar to the [original Python version](h
---
This package is still in its early stages.
These packages are still in their early stages. Specifically, they're probably not as well-optimised as we'd like.
An example bot that uses this package can be found [here](https://gist.github.com/DanielOaks/cbbc957e8dba39f59d9e).
An example bot that uses these packages can be found [here](https://gist.github.com/DanielOaks/cbbc957e8dba39f59d9e).
Packages:

12
doc.go
View File

@ -2,9 +2,15 @@
// released under the ISC license
/*
Package girc helps create and manage an IRC connection.
Package girc has useful, self-contained packages that help with IRC
development. The packages are split up so you can use something like the
formatting package, while totally ignoring the provided event management
package.
This package is in its early stages. For the status of each subpackage, see the
documentation for those packages.
An example bot that uses these packages can be found here:
https://gist.github.com/DanielOaks/cbbc957e8dba39f59d9e
These packages are in their early stages. For the status of each package, see
the documentation for each packages.
*/
package girc