diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 13 insertions, 3 deletions
@@ -1,16 +1,26 @@ # Irc -An IRC toolkit for Elixir. Compatible IRCv3! +An modern IRC toolkit for Elixir. Compatible IRCv3! * `Irc.Parser` a versatile IRC parser; * `Irc.Connection` a basic IRC connection (handling registration and socket); -* `Irc.BaseClient` an extensible IRC client; -* `Irc.Client` a classical IRC client (implemented on BasicClient). +* `Irc.Client` a fully featured and extensible IRC client. Examples of usage: `Irc.Shout` (a simple connect-join-message-quit on Connection), `Irc.Client` on BaseClient. Future versions may include: bots, server parser, server-to-server connections, …. +### Supported features + +The eventual goal is to support most of the modern IRC specifications. + +The parser supports the following capabs: `message-tags`, `multi-prefix`, `account-tag`, `server-time`. + +The connection supports the following: `sasl`, `sts`, `cap-notify`, `batch`. + +The client has modules for the following: `account-notify`, `away-notify`, `userhost-in-names`, `chghost`, +`invite-notify`, `extended-join`; and `labeled-response` - `echo-message`. + ## Installation If [available in Hex](https://hex.pm/docs/publish), the package can be installed |