Crirc

A crystal library to create irc client/bot/server.

Works with crystal v0.23.0

Installation

To install the lib, you will have to add the Crirc dependancy to your project.

Add this to your application's shard.yml:

dependencies:
  Crirc:
    github: Meoowww/Crirc
    branch: master # because it is still in dev

Then, run crystal deps install to fetch the lib.

Documentation

The documentation is built automaticaly when a commit is pushed on master on github, via Travis: https://meoowww.github.io/Crirc/. This explains the architecture and design on the library, and details the technical informations about the internal & external API.

Specifications (unit tests) are written into the /spec directory.

A full implementation of a bot is published and maintained on https://github.com/Meoowww/DashBot.

Contributing

1. Fork it ( https://github.com/Meoowww/Crirc/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Nephos Arthur Poulet - creator, maintainer
• Damaia Lucie Dispot - developer