crirc

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# Crirc

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

## Installation

[![travis](https://travis-ci.org/Meoowww/Crirc.svg)](https://travis-ci.org/Meoowww/Crirc)

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

Add this to your application's `shard.yml`:

```yaml
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](https://github.com/Nephos) Arthur Poulet - creator, maintainer
- [Damaia](https://github.com/Lucie-Dispot) Lucie Dispot - developer