64 lines
3.2 KiB
Markdown
64 lines
3.2 KiB
Markdown
## girc is a flexible IRC library for Go
|
|
|
|
[](https://travis-ci.org/Liamraystanley/girc)
|
|
[](https://godoc.org/github.com/Liamraystanley/girc)
|
|
[](https://codebeat.co/projects/github-com-liamraystanley-girc)
|
|
[](https://goreportcard.com/report/github.com/Liamraystanley/girc)
|
|
[](http://byteirc.org/channel/L)
|
|
[](https://github.com/Liamraystanley/girc/issues)
|
|
[](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
|
|
|
|
- [ ] `ClearCallbacks(cmd string)`?
|
|
- [ ] Should Client.Message() an other similar methods support errors?
|
|
- [ ] along with this, should we forcefully check to ensure that the target/events are valid?
|
|
- [ ] track connection time (`conntime`? in state)
|
|
- [ ] with conntime, find lag. `Client.Lag()` would be useful
|
|
- [ ] 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)
|
|
- [ ] users need to be exposed in state somehow (other than `GetChannels()`)
|
|
- [ ] ip/host binding?
|
|
- [ ] `User.Age()`? (`FirstActive()`?) (time since first seen)
|
|
- [ ] cleanup docs in conn.go & event.go
|
|
- [ ] add `DISCONNECTED` command state
|
|
- [ ] add `Client.IsInChannel()`? and/or basic channel list
|
|
- [ ] add `Client.Topic(topic string)`
|
|
- [ ] `MODE` tracking on a per-channel basis
|
|
- [ ] `Event.PrettyString()`?
|
|
- [ ] `Client.AddTmpCallback()` for one time use callbacks?
|
|
- [ ] implement id's for callbacks, for allowance of removal?
|
|
|
|
## Installing
|
|
|
|
$ go get -u github.com/Liamraystanley/girc
|
|
|
|
## Examples
|
|
|
|
See [girc/examples/](https://github.com/Liamraystanley/girc/tree/master/example) 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>
|
|
```
|