kayos
/
girc-atomic
1
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
lmao probably don't use this your computer may explode
228 Commits 4 Branches 11 Tags 795 KiB
Go 100%
Go to file
Liam Stanley de697eb4e5 implement CModes.Get() 2017-02-08 02:18:53 -05:00
.travis.yml rename Prefix to Source 2016-11-19 09:36:17 -05:00
LICENSE first commit 2016-11-13 03:30:43 -05:00
README.md update warnings in readme 2017-02-05 07:23:00 -05:00
caller.go ignore nil events that one may attempt to execute 2017-02-07 05:34:33 -05:00
cap.go add support for ircv3's multi-prefix functionality 2017-02-08 01:25:22 -05:00
client.go update documentation 2017-02-08 01:44:37 -05:00
client_test.go rename MaxRetries -> Retries 2017-02-07 06:12:30 -05:00
conn.go better description if returned results 2017-02-07 05:34:15 -05:00
contants.go initial push to track MODE events 2017-02-06 08:02:26 -05:00
ctcp.go update copyright to remove year 2017-02-06 02:45:31 -05:00
ctcp_test.go update copyright to remove year 2017-02-06 02:45:31 -05:00
doc.go update copyright to remove year 2017-02-06 02:45:31 -05:00
event.go add host to pretty join evvents 2017-02-08 02:14:14 -05:00
event_test.go update copyright to remove year 2017-02-06 02:45:31 -05:00
format.go add additional noting in regards to channel id lengths and ISUPPORT 2017-02-07 06:28:35 -05:00
format_test.go update copyright to remove year 2017-02-06 02:45:31 -05:00
handlers.go update documentation 2017-02-08 01:44:37 -05:00
modes.go implement CModes.Get() 2017-02-08 02:18:53 -05:00
source.go update copyright to remove year 2017-02-06 02:45:31 -05:00
source_test.go update copyright to remove year 2017-02-06 02:45:31 -05:00
state.go update docs for new mode additions 2017-02-07 06:08:17 -05:00

README.md

girc -- A flexible IRC library for Go

Build Status GoDoc Go Report Card IRC Chat GitHub Issues License

Status

EXPECT BREAKING CHANGES TO OCCUR FREQUENTLY. girc has not hit version 1.0.0 yet!

Changes are actively being made. At this time, most of the stateful parts of girc are not accessible, as well as other minor consistencies while things are still being flushed out. Not production ready! You've been warned!

Features

  • Focuses on simplicity, yet tries to still be flexible.
  • Only requires standard library packages.
  • Event based triggering/responses (and CTCP too!).
  • Documentation is mostly on par.
  • Full support for the IRCv3 spec.
  • Channel and user tracking. Easily find what users are in a channel, if a user is away, or if they are authenticated.
  • Client state/capability tracking. Easy methods to access capability data.
  • Built-in support for things you would commmonly have to implement yourself.
    • Nick collision detection and prevention.
    • Event/message rate limiting.
    • Channel, nick, and user validation on connection methods.
    • CTCP handling and auto-responses.

TODO

To review what is currently being worked on, or looked into, feel free to head over to the project board or the issues list.

Installing

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

Examples

See the examples within the documentation for real-world usecases.

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>