Go to file
Arthur POULET 8df53b2140 Add some documentation to Network, Controller, and Protocol 2017-12-27 16:37:58 +01:00
spec Use fast_irc for command JOIN 2017-11-26 22:56:18 +01:00
src Add some documentation to Network, Controller, and Protocol 2017-12-27 16:37:58 +01:00
.editorconfig Initialize the project 2017-10-30 20:06:54 +01:00
.gitignore Initialize the project 2017-10-30 20:06:54 +01:00
.travis.yml Initialize the project 2017-10-30 20:06:54 +01:00
CHANGELOG.md update CHANGELOG and README 2016-08-04 14:22:09 +02:00
LICENSE Initialize the project 2017-10-30 20:06:54 +01:00
Makefile Fix some stuff and add specs for protocol 2017-11-01 11:42:57 +01:00
README.md Add some documentation to Network, Controller, and Protocol 2017-12-27 16:37:58 +01:00
shard.yml Use fast_irc for command JOIN 2017-11-26 22:56:18 +01:00

README.md

Crirc

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

Works with crystal v0.23.0

Installation

travis

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

Add this to your application's shard.yml:

dependencies:
  CrystalIrc:
    github: Meoowww/Crirc

Then, run crystal deps install to fetch the lib.

Development

  • Network: A network object manage a socket / IO
  • Controller: A controller belongs to a network object, and handle the logic and data
  • Protocol: A protocol object represent a IRC entity (chan, user, message, ...)
  • Binding: The binding socket to allow the system to respond to incoming transmissions

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