girc-atomic/README.md

## girc is a flexible IRC library for Go

[![Build Status](https://travis-ci.org/Liamraystanley/girc.svg?branch=master)](https://travis-ci.org/Liamraystanley/girc)
[![GoDoc](https://godoc.org/github.com/Liamraystanley/girc?status.png)](https://godoc.org/github.com/Liamraystanley/girc)
[![codebeat badge](https://codebeat.co/badges/67d01d61-d5e9-4854-ae22-0ac262dd7690)](https://codebeat.co/projects/github-com-liamraystanley-girc)
[![Go Report Card](https://goreportcard.com/badge/github.com/Liamraystanley/girc)](https://goreportcard.com/report/github.com/Liamraystanley/girc)
[![IRC Chat](https://img.shields.io/badge/ByteIRC-%23L-blue.svg)](http://byteirc.org/channel/L)
[![GitHub Issues](https://img.shields.io/github/issues/Liamraystanley/girc.svg)](https://github.com/Liamraystanley/girc/issues)
[![license](https://img.shields.io/github/license/Liamraystanley/girc.svg)](https://raw.githubusercontent.com/Liamraystanley/girc/master/LICENSE)

## 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**.

## TODO

- [ ] would be cool to track things like `SERVERNAME`, `VERSION`, `UMODES`, `CMODES`, etc. also see `Config.DisableCapTracking`. [e.g. here](https://github.com/Liamraystanley/Code/blob/master/core/triggers.py#L40-L67)
- [ ] client should support ping tracking (sending `PING`'s to the server)
  - [ ] with this, we can potentially find lag. `Client.Lag()` would be useful
- [ ] users need to be exposed in state somehow (other than `GetChannels()`)
- [ ] `User.Age()`? (`FirstActive()`?) (time since first seen)
- [ ] add `Client.IsInChannel()`? and/or basic channel list
- [ ] add `Client.Topic(topic string)`
- [ ] `MODE` tracking on a per-channel basis
- [ ] `Client.AddTmpCallback()` for one time use callbacks?

## Installing

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

## Examples

See [girc/examples/](https://github.com/Liamraystanley/girc/tree/master/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](https://github.com/golang/go/wiki/CodeReviewComments)

## License

```
The MIT License (MIT); Copyright (c) Liam Stanley <me@liamstanley.io>
```
moar updaets 2016-11-14 07:31:21 +00:00			`## girc is a flexible IRC library for Go`
first commit 2016-11-13 08:30:43 +00:00
			`[![Build Status](https://travis-ci.org/Liamraystanley/girc.svg?branch=master)](https://travis-ci.org/Liamraystanley/girc)`
			`[![GoDoc](https://godoc.org/github.com/Liamraystanley/girc?status.png)](https://godoc.org/github.com/Liamraystanley/girc)`
update codebeat badge, add exampels link 2016-11-13 08:36:02 +00:00			`[![codebeat badge](https://codebeat.co/badges/67d01d61-d5e9-4854-ae22-0ac262dd7690)](https://codebeat.co/projects/github-com-liamraystanley-girc)`
first commit 2016-11-13 08:30:43 +00:00			`[![Go Report Card](https://goreportcard.com/badge/github.com/Liamraystanley/girc)](https://goreportcard.com/report/github.com/Liamraystanley/girc)`
update readme 2016-11-14 07:27:27 +00:00			`[![IRC Chat](https://img.shields.io/badge/ByteIRC-%23L-blue.svg)](http://byteirc.org/channel/L)`
			`[![GitHub Issues](https://img.shields.io/github/issues/Liamraystanley/girc.svg)](https://github.com/Liamraystanley/girc/issues)`
			`[![license](https://img.shields.io/github/license/Liamraystanley/girc.svg)](https://raw.githubusercontent.com/Liamraystanley/girc/master/LICENSE)`

first commit 2016-11-13 08:30:43 +00:00			`## Features`

			`- Focuses on simplicity, yet tries to still be flexible`
			`- Only requires standard packages`
			`- Event based triggering/responses`
implement Client.Message() and Client.Messagef() 2016-11-13 13:52:16 +00:00			`- Documentation is mostly on par`
add note about breaking changes 2016-11-14 12:02:31 +00:00			`- At this time, expect breaking changes to occur frequently.`
first commit 2016-11-13 08:30:43 +00:00
add TODO's to README.md 2016-11-18 04:20:42 +00:00			`## TODO`

			- [ ] would be cool to track things like `SERVERNAME`, `VERSION`, `UMODES`, `CMODES`, etc. also see `Config.DisableCapTracking`. [e.g. here](https://github.com/Liamraystanley/Code/blob/master/core/triggers.py#L40-L67)
			- [ ] client should support ping tracking (sending `PING`'s to the server)
implement Client.ConnTime() and Client.ConnSince() 2016-11-25 00:18:39 +00:00			- [ ] with this, we can potentially find lag. `Client.Lag()` would be useful
add TODO's to README.md 2016-11-18 04:20:42 +00:00			- [ ] users need to be exposed in state somehow (other than `GetChannels()`)
			- [ ] `User.Age()`? (`FirstActive()`?) (time since first seen)
add more TODOs 2016-11-18 04:26:02 +00:00			- [ ] add `Client.IsInChannel()`? and/or basic channel list
			- [ ] add `Client.Topic(topic string)`
			- [ ] `MODE` tracking on a per-channel basis
implement IsValidNick() 2016-11-18 20:17:09 +00:00			- [ ] `Client.AddTmpCallback()` for one time use callbacks?
add TODO's to README.md 2016-11-18 04:20:42 +00:00
first commit 2016-11-13 08:30:43 +00:00			`## Installing`

			`$ go get -u github.com/Liamraystanley/girc`
update codebeat badge, add exampels link 2016-11-13 08:36:02 +00:00
			`## Examples`

update examples to be multiple different files 2016-11-23 18:01:10 +00:00			`See [girc/examples/](https://github.com/Liamraystanley/girc/tree/master/examples) for some examples.`
update readme 2016-11-14 07:27:27 +00:00
			`## 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](https://github.com/golang/go/wiki/CodeReviewComments)`

			`## License`

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