summaryrefslogtreecommitdiff
path: root/deps/irc-conduit/README.markdown
diff options
context:
space:
mode:
authorLLLL Colonq <llll@colonq>2023-11-16 19:06:43 -0500
committerLLLL Colonq <llll@colonq>2023-11-16 19:06:43 -0500
commitdcef0b65069fb38fd0f6c4382353167f603ebff1 (patch)
tree45954ffe308c3dd056e6af4f734e6d2af89e5856 /deps/irc-conduit/README.markdown
Initial commit
Diffstat (limited to 'deps/irc-conduit/README.markdown')
-rw-r--r--deps/irc-conduit/README.markdown40
1 files changed, 40 insertions, 0 deletions
diff --git a/deps/irc-conduit/README.markdown b/deps/irc-conduit/README.markdown
new file mode 100644
index 0000000..73b61a0
--- /dev/null
+++ b/deps/irc-conduit/README.markdown
@@ -0,0 +1,40 @@
+**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-conduit][]
+============
+
+Streaming IRC message library using conduits.
+
+ - Provides [conduits][conduit] for translating bytestrings into
+ "events", and "messages" into bytestrings.
+
+ - Provides a sum type for all IRC messages you're likely to want to
+ deal with in a client.
+
+ - Provides two helper functions for connecting to IRC servers
+ directly.
+
+ - Manages flood protection when connecting to a server directly.
+
+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-conduit]: http://hackage.haskell.org/package/irc-conduit
+[conduit]: https://hackage.haskell.org/package/conduit
+[yukibot]: https://github.com/barrucadu/yukibot