Arthur POULET
1aab6b69c7
|
||
|---|---|---|
| spec | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| shard.yml | ||
README.md
Crirc
A crystal library to create irc client/bot/server.
Installation
github mirror: 
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
- Fork it ( https://git.sceptique.eu/Sceptique/Crirc/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request