summaryrefslogtreecommitdiff
path: root/deps/irc-client/README.markdown
blob: 36e294f70f8ccd1a4ee447ed2ef74c7e5fcd7a9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
**This project is essentially abandonware!**

I may respond to minor issues, like version bounds which need
changing, but I won't be doing any significant work.

Offer to take over the package if you want any significant changes.

[irc-client][]
===========

An IRC client library.

 - Built on [irc-conduit][].

 - Handles a connection to a single IRC server.

 - Manages "event handlers", calling them as appropriate on receipt of
   messages.

 - Provides default event handlers for some common messages (e.g.,
   server PINGs).

 - Executes each event handler in its own thread, and uses a message
   queue to guarantee thread-safe message delivery.

 - Provides a few helper functions for common operations.

Note
----

This used to be a part of [yukibot][], so if you want the history from
before this was split out into its own library, check there.

Contributing
------------

Bug reports, pull requests, and comments are very welcome!

Feel free to contact me on GitHub, through IRC (#haskell on
libera.chat), or email (mike@barrucadu.co.uk).

[irc-client]:  https://hackage.haskell.org/package/irc-client
[irc-conduit]: https://hackage.haskell.org/package/irc-conduit
[yukibot]:     https://github.com/barrucadu/yukibot