Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 1.54 KB

README.md

File metadata and controls

73 lines (52 loc) · 1.54 KB

nwitch-abstract

Build Status Dependency Status

nwitch (and slate-irc) plugin for getting a nice abstract on any topic.

05:34 <KenanY> !abstract astronomy
05:34 <nwitch> KenanY: Astronomy A natural science that is the study of
               celestial objects, the physics, chemistry, and...

Example

As a nwitch plugin (using config.toml):

[plugins]
nwitch-abstract = true

Or through nwitch's API:

var Nwitch = require('nwitch');
var nwitchAbstract = require('nwitch-abstract');

var nwitch = new Nwitch({
  irc: {
    address: 'irc.freenode.org',
    port: 6667
  }
});

nwitch.use(nwitchAbstract());

Technically, all nwitch plugins are just slate-irc plugins, so you could also use this as a slate-irc plugin:

var net = require('net');
var irc = require('slate-irc');
var nwitchAbstract = require('nwitch-abstract');

var stream = net.connect({
  port: 6667,
  host: 'irc.freenode.org'
});

var client = irc(stream);
client.use(nwitchAbstract());

Installation

$ npm install nwitch-abstract

API

var nwitchAbstract = require('nwitch-abstract');

nwitchAbstract()

Returns a function that accepts an instance of slate-irc.