Go to file
2021-03-27 11:32:35 +01:00
spec More hooks doc and rename HookTest to Trigger 2018-03-01 10:47:11 +01:00
src update to crystal 0.34.0 2020-04-13 17:49:27 +08:00
.editorconfig Initialize the project 2017-10-30 20:06:54 +01:00
.gitignore Documentate Broadcast 2018-03-01 10:05:41 +01:00
.travis.yml Improve .travis.yml to deploy doc 2018-03-01 09:30:37 +01:00
CHANGELOG.md update CHANGELOG and README 2016-08-04 14:22:09 +02:00
LICENSE Change LICENSE 2019-12-04 23:56:44 +01:00
Makefile Update makefile 2020-04-20 00:27:20 +02:00
README.md documentation: Update forge urls 2021-03-27 11:32:35 +01:00
shard.yml documentation: Update forge urls 2021-03-27 11:32:35 +01:00

Crirc

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

Installation

github mirror: travis

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

Add this to your application's shard.yml:

dependencies:
  crirc:
    git: https://git.sceptique.eu/Sceptique/Crirc
    branch: master

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://git.sceptique.eu/Sceptique/DashBot.

Contributing

  1. Fork it ( https://git.sceptique.eu/Sceptique/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

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