diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e99077 --- /dev/null +++ b/README.md @@ -0,0 +1,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). + |