diff --git a/README.md b/README.md new file mode 100644 index 0000000..3447ba8 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +Taiga events +============ + +![Kaleidos Project](http://kaleidos.net/static/img/badge.png "Kaleidos Project") +[![Managed with Taiga.io](https://taiga.io/media/support/attachments/article-22/banner-gh.png)](https://taiga.io "Managed with Taiga.io") + +The Taiga websocket server. + +Installation +------------ + +Install the RabbitMQ service. + +```bash + apt-get install rabbitmq-server +``` + +Install the javascript dependencies. + +```bash + npm install +``` + +Install globally the coffeescript interpreter. + +```bash + sudo npm install -g coffee-script +``` + +Copy and edit the config.json file. + +```bash + cp config.example.json config.json +``` + +Then run the taiga events service + +```bash + coffee index.coffee +```