girc-atomic/README.md

girc is a flexible IRC library for Go

Features

• Focuses on simplicity, yet tries to still be flexible
• Only requires standard packages
• Event based triggering/responses
• Documentation is mostly on par
• At this time, expect breaking changes to occur frequently.

Installing

$ go get -u github.com/Liamraystanley/girc

Examples

See girc/examples/ for some examples.

Contributing

Below are a few guidelines if you would like to contribute. Keep the code clean, standardized, and much of the quality should match Golang's standard library and common idioms.

• Always test using the latest Go version.
• Always use gofmt before committing anything.
• Always have proper documentation before committing.
• Keep the same whitespacing, documentation, and newline format as the rest of the project.
• Only use 3rd party libraries if necessary. If only a small portion of the library is needed, simply rewrite it within the library to prevent useless imports.
• Also see golang/go/wiki/CodeReviewComments

License

The MIT License (MIT); Copyright (c) Liam Stanley <me@liamstanley.io>