Sceptique
/
Crirc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
253 Commits 5 Branches 5 Tags 612 KiB
Crystal 99.4%
Makefile 0.6%
Go to file
Arthur POULET cb049c7312
Update version 		2019-12-04 23:57:03 +01:00
spec More hooks doc and rename HookTest to Trigger 2018-03-01 10:47:11 +01:00
src Update some doc 2019-12-04 23:54:52 +01: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 Fix some stuff and add specs for protocol 2017-11-01 11:42:57 +01:00
README.md Update to work with crystal v0.27.0 2018-12-25 02:46:55 +01:00
shard.yml Update version 2019-12-04 23:57:03 +01:00

README.md

Crirc

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

Installation

travis

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

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