v0.5.0

Author: The-Clockmaker

CHANGELOG.md

@@ -1,3 +1,19 @@
+<a name="0.5.0"></a>
+# [0.5.0](https://github.com/SupportClass/streen/compare/v0.4.0...v0.5.0) (2017-02-01)
+
+
+### Features
+
+* add pre-shared key authentication ([e78410a](https://github.com/SupportClass/streen/commit/e78410a))
+* **api:** use object for `chat` and `timeout` events ([c99f945](https://github.com/SupportClass/streen/commit/c99f945))
+
+
+### BREAKING CHANGES
+
+* api: The `chat` and `timeout` events now pass a single object as their argument.
+
+
+
 <a name="0.4.0"></a>
 # [0.4.0](https://github.com/SupportClass/streen/compare/v0.3.2...v0.4.0) (2017-02-01)
 

README.md

@@ -1,16 +1,17 @@
 #Streen [![Build Status](https://travis-ci.org/SupportClass/streen.svg?branch=master)](https://travis-ci.org/SupportClass/streen) [![Coverage Status](https://coveralls.io/repos/github/SupportClass/streen/badge.svg?branch=master)](https://coveralls.io/github/SupportClass/streen?branch=master)
 Streen is a centralized interface for interacting with Twitch Chat. It is essentially a wrapper for 
-[twitch-irc](https://github.com/twitch-irc/twitch-irc), and it operates via IPC.
+[twitch-irc](https://github.com/twitch-irc/twitch-irc), and it operates via Socket.IO websockets.
 
 Streen is useful in situations where multiple processes all need to connect to Twitch Chat, 
-but the overhead of spinning up multiple IRC bots is not acceptable. Streen operates as a single bot and exposes
-an evented IPC interface via [axon](https://github.com/tj/axon).
+but the overhead of spinning up multiple and managing multiple IRC bots is not acceptable. 
+Streen operates as a single bot and exposes a websocket API.
 
 ## Installation
 - Clone the repository
 - From the directory you cloned Streen into, run `npm install --production`
-- Create `./config.json` with the desired Twitch `username` and `password`. Optionally, add a 
-[`slack.botToken`](https://my.slack.com/services/new/bot) and `slack.statusChannel` 
+- Create `./config.json` with the desired `twitch.username`, `twitch.password`, and `secretKey`. 
+The `secretKey` is a pre-shared key that all clients must provide in order to use the websocket API.
+- Optionally, add a [`slack.botToken`](https://my.slack.com/services/new/bot) and `slack.statusChannel` 
 to have Streen post critical status updates and respond to commands. 
 [(Need an avatar for your bot?)](http://i.imgur.com/7LNvGeK.jpg)
 ```json
@@ -23,7 +24,10 @@ to have Streen post critical status updates and respond to commands.
   "slack": {
     "botToken": "xoxb-xxxxxxxxxx-yyyyyyyyyy",
     "statusChannel": "#somechannel"
-  }
+  },
+  "port": 8232,
+  "logLevel": "info",
+  "secretKey": "xxxxx"
 }
 ```
 - Run with `node server.js`
@@ -33,11 +37,11 @@ See [lfg-siphon](https://github.com/SupportClass/lfg-siphon) for an example impl
 
 ## Slack Commands
 ### !channels
-Lists the current Twitch chat channels that Streen is listening to.
+Lists the current Twitch chat channels that Streen is listening to.  
 ![channels command example](https://i.imgur.com/072ECjo.png)
 
 ### !online
-Lists the online status of each Twitch stream that Streen is listening to.
+Lists the online status of each Twitch stream that Streen is listening to.  
 ![online command example](https://i.imgur.com/TMiOISh.png)
 
 ### License

package.json

@@ -2,7 +2,7 @@
   "name": "streen",
   "description": "An IPC wrapper for twitch-irc",
   "main": "server.js",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SupportClass/streen.git"