Adds options primusOptions and dispatcherOptions

and a shitty start to server documentation

i want to abstract most of the annoying piping, in/out files, remote servers,
primus/other connection, and boilerplate into lib/server to save everyone the
hassle, and allow us to update it when bugs/api changes arise.

Author: grrowl

CHANGELOG.md

@@ -1,6 +1,7 @@
-# 0.3.4
+# 0.3.4-0.3.5
 
-* Adds `server` options `connectRedux` and `getStatistics`
+* Adds `server` options `connectRedux`, `getStatistics`, `primusOptions` and
+  `dispatcherOptions`
 
 # 0.3.3
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-scuttlebutt",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Redux distributed dispatcher",
   "main": "lib/index.js",
   "engines": {

server.md

@@ -0,0 +1,25 @@
+
+```js
+var scuttlebutt = require('redux-scuttlebutt/lib/server').default
+var serverOptions = {}
+
+scuttlebutt(server, serverOptions)
+```
+
+# server options
+
+### `dispatcherOptions` and `primusOptions`
+
+## `connectRedux(gossip)`
+
+gossip is a store enhancer, connect it to redux
+
+## `getStatistics()`
+
+return value will be called with (source, event), so you can render statistics
+
+## env vars
+
+### `INFILE`, `OUTFILE`
+
+### `SB_REMOTE`

src/server.js

@@ -7,18 +7,20 @@ const INFILE = process.env['INFILE'],
 const defaultOptions = {
   connectRedux,
   getStatistics,
+  primusOptions: {},
+  dispatcherOptions: {},
 }
 
 export default function scuttlebuttServer(server, options) {
   options = { ...defaultOptions, ...options }
 
-  const primusServer = new (require('primus'))(server, {}),
+  const primusServer = new (require('primus'))(server, options.primusOptions),
       Dispatcher = require('./dispatcher').default,
-      gossip = new Dispatcher(),
-      onStatistic = getStatistics()
+      gossip = new Dispatcher(options.dispatcherOptions),
+      onStatistic = options.getStatistics()
 
   // connect dispatcher to redux
-  connectRedux(gossip)
+  options.connectRedux(gossip)
 
   // read actions from file
   if (INFILE) {