You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Arthur POULET 1aab6b69c7
documentation: Update forge urls
3 weeks ago
spec More hooks doc and rename HookTest to Trigger 3 years ago
src update to crystal 0.34.0 1 year ago
.editorconfig Initialize the project 4 years ago
.gitignore Documentate Broadcast 3 years ago
.travis.yml Improve .travis.yml to deploy doc 3 years ago
CHANGELOG.md update CHANGELOG and README 5 years ago
LICENSE Change LICENSE 1 year ago
Makefile Update makefile 1 year ago
README.md documentation: Update forge urls 3 weeks ago
shard.yml documentation: Update forge urls 3 weeks ago

README.md

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