druid/README.md

NodeJS Jabber bot framework

# Druid - A NodeJS Jabber bot framework

Druid is a small library for NodeJS to ease the development of Jabber bots.
The main reason behind it was implementing a small bugbot for the MUC
chat rooms we use [at work](http://igalia.com).


## License

The source code is distributed under the terms of the [MIT
license](http://opensource.org/licenses/mit).


## Dependencies

`npm` can be used to install the dependencies, use the following command:

```sh
npm install cheerio request node-xmpp node-stringprep
```


## BotBuggy

The [BotBuggy](bbuggy) bot included, it uses the [Bugzilla](bugzilla.js)
plug-in to show the descriptions of bugs when a bug URL is mentioned by
in a chat room. Also, expansion of “instance prefixes“ to URLs is performed,
for example bugs mentioned as `fdo#1234` can be expandes by the bot to the
bug URL adding the following in the `config.json` file:

```js
{
    // ...
    "bugzilla": {
        "fdo": "https://bugs.freedesktop.org"
    }
}
```