diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -1,10 +1,12 @@ -# Irc +# Elixir/Irc -An modern IRC toolkit for Elixir. Compatible IRCv3! +A modern IRC toolkit for Elixir. Compatible IRCv3. Meant to build clients, bouncers, bots, servers, and services. * `Irc.Parser` a versatile IRC parser; * `Irc.Connection` a basic IRC connection (handling registration and socket); -* `Irc.Client` a fully featured and extensible IRC client. +* `Irc.Server` client server (todo); +* `Irc.TS6` TS6 Server (todo); +* `Irc.Client` a fully featured and extensible IRC client (should be usable with `.Connection`, `.Server` or `.TS6`). Examples of usage: `Irc.Shout` (a simple connect-join-message-quit on Connection), `Irc.Client` on BaseClient. @@ -39,4 +41,3 @@ end Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) and published on [HexDocs](https://hexdocs.pm). Once published, the docs can be found at [https://hexdocs.pm/irc](https://hexdocs.pm/irc). - |