blob: 8e990772c3dc43e39130727348006e76b267e9e0 (
plain) (
blame)
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
|
# Irc
An 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).
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, ….
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `irc` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:irc, "~> 0.1.0"}
]
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).
|
