# nwitch

[![Dependency Status](https://gemnasium.com/KenanY/nwitch.png)](https://gemnasium.com/KenanY/nwitch)

nwitch is a simple, pluggable IRC bot written in JavaScript and designed to work
in [Node.js](http://nodejs.org/).

nwitch was initially conceived as a [TwitchTV](http://www.twitch.tv/) chat
moderation bot, whose functions would be defined through individual plugins.
However, its scope has since widened, considering how it is the plugins that
choose whether to be specific to TwitchTV or not.

Currently, nwitch is in early development. There are no guarantees that anything
is working at any particular point in time.

## Installation

  - [TwitchTV guide](https://github.com/KenanY/nwitch/wiki/TwitchTV)

``` bash
$ npm install nwitch
```

## API

### new Nwitch(config)

Creates a new Nwitch instance.

### #use(plugin)

Adds the given `plugin` function.
# nwitch

[![Dependency Status](https://gemnasium.com/KenanY/nwitch.png)](https://gemnasium.com/KenanY/nwitch)

nwitch is a simple, pluggable IRC bot written in JavaScript and designed to work
in [Node.js](http://nodejs.org/).

nwitch was initially conceived as a [TwitchTV](http://www.twitch.tv/) chat
moderation bot, whose functions would be defined through individual plugins.
However, its scope has since widened, considering how it is the plugins that
choose whether to be specific to TwitchTV or not.

Currently, nwitch is in early development. There are no guarantees that anything
is working at any particular point in time.

## Installation

  - [TwitchTV guide](https://github.com/KenanY/nwitch/wiki/TwitchTV)

``` bash
$ npm install nwitch
```

## API

``` javascript
var Nwitch = require('nwitch');
```

### var nwitch = new Nwitch(config)

Creates a new Nwitch instance with options `config`:

  - `config.irc.address`
  - `config.irc.port`
  - `config.account.username`
  - `config.account.password`
  - `config.account.channel`

### nwitch.use(plugin)

Adds the given `plugin` function. Returns `nwitch` for chaining.
Make API docs match doc style of my other modules
Make API docs match doc style of my other modules

Closes #22
