summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/lrstanley/girc/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/lrstanley/girc/doc.go')
-rw-r--r--vendor/github.com/lrstanley/girc/doc.go12
1 files changed, 12 insertions, 0 deletions
diff --git a/vendor/github.com/lrstanley/girc/doc.go b/vendor/github.com/lrstanley/girc/doc.go
new file mode 100644
index 00000000..e46a41aa
--- /dev/null
+++ b/vendor/github.com/lrstanley/girc/doc.go
@@ -0,0 +1,12 @@
+// Package girc provides a high level, yet flexible IRC library for use with
+// interacting with IRC servers. girc has support for user/channel tracking,
+// as well as a few other neat features (like auto-reconnect).
+//
+// Much of what girc can do, can also be disabled. The goal is to provide a
+// solid API that you don't necessarily have to work with out of the box if
+// you don't want to.
+//
+// See the examples below for a few brief and useful snippets taking
+// advantage of girc, which should give you a general idea of how the API
+// works.
+package girc