Add example configuration and instructions to repo.

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jimmy Hillis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,3 +1,36 @@
-# slackirc
+# Slack IRC Plugin
 
 IRC integration with [slack](http://slack.com).
+
+## Usage
+
+Write your own configuration file (`config-example.js`) is a good starting point for building your own.
+
+```javascript
+var config = {
+    server: 'irc.freenode.com',
+    nick: 'slackbot',
+    token: 'XXXX-XXXXXXXXXX-XXXXXXXXXX-XXXXXXXXXX-XXXXXX',
+    channels: {
+        '#irc-channel': '#slack-channel'
+    },
+    users: {
+        '~irclogin': 'slackuser'
+    }
+}
+```
+
+Save this to a file in the root of the project then run your bot with:
+
+    node your-config
+
+This will launch the bot in your terminal based on provided configuration.
+
+## Configuration
+
+- `server`: IRC server
+- `nick`: IRC bot's nickname
+- `token`: Your Slack API token
+- `channels`: Map of IRC channel to Slack channel names
+- `users`: Map of IRC nick to Slack username
+

config-example.js

@@ -0,0 +1,16 @@
+var slackbot = require('./lib/bot');
+
+var config = {
+    server: 'irc.freenode.com',
+    nick: 'slackbot',
+    token: 'XXXX-XXXXXXXXXX-XXXXXXXXXX-XXXXXXXXXX-XXXXXX',
+    channels: {
+        '#irc-channel': '#slack-channel'
+    },
+    users: {
+        '~irclogin': 'slackuser'
+    }
+};
+
+var slackbot = new slackbot.Bot(config);
+slackbot.listen();