An open API service indexing awesome lists of open source software.

https://github.com/hyperimpose/irc

IRC client library. The project aims to abstract the IRC protocol completely and provide easy access to the state of the connection. It can be used to implement any kind of service.
https://github.com/hyperimpose/irc

client erlang hyperimpose irc irc-client

Last synced: 3 days ago
JSON representation

IRC client library. The project aims to abstract the IRC protocol completely and provide easy access to the state of the connection. It can be used to implement any kind of service.

Awesome Lists containing this project

README

          

#+OPTIONS: ^:nil

* irc

*This is a pre-release version and its API may break*

An irc client library for Erlang 28 or later.

** Main Features
Some of the features offered are:

- An extensive implementation of the IRC protocol
- ISUPPORT, IRCv3, CTCP support
- Easy access to the connection state
- Multiple connections

** Install
You can include this library in your projects as a dependency in rebar.config:

#+BEGIN_SRC erlang
{deps, [%% ... Other dependencies
{irc, {git, "https://github.com/hyperimpose/irc.git", {branch, "master"}}}]}.
#+END_SRC

** Documentation

The library is documented using ExDoc. To build the documentation run:
#+BEGIN_SRC bash
$ rebar3 ex_doc
#+END_SRC

You can view the generated configuration in ~doc/exdoc/~.

** License

irc is licensed under the [[https://www.gnu.org/licenses/agpl-3.0.html][GNU Affero General Public License version 3 (AGPLv3)]].
#+BEGIN_CENTER
[[https://www.gnu.org/graphics/agplv3-with-text-162x68.png]]
#+END_CENTER

A copy of this license is included in the file [[../../COPYING][COPYING]].