Make ot-socialcalc default ottype

README.md

@@ -7,20 +7,16 @@ It utilizes the [ot-socialcalc](https://github.com/marcelklehr/ot-socialcalc) OT
 ## Install
 
 ```
-npm install --save gulf gulf-editor-codemirror ot-socialcalc
+npm install --save gulf-editor-codemirror
 ```
 
 ## Usage
 
 ```js
-const gulf = require('gulf')
-const socialcalcOT = require('ot-socialcalc')
 const SocialcalcDocument = require('gulf-editor-socialcalc')
 
 var doc = new SocialcalcDocument({
-  storageAdapter: new gulf.MemoryAdapter
-, ottype: socialcalcOT
-, editorInstance: socialcalcControl
+  editorInstance: socialcalcControl
 })
 
 masterStream.pipe(doc.masterLink()).pipe(masterStream)
@@ -29,8 +25,8 @@ masterStream.pipe(doc.masterLink()).pipe(masterStream)
 ## API
 ### class CodemirrorDocument({editorInstance:SocialcalcControl, ...}) extends gulf.EditableDocument
   * `editorInstance` -- a SocialcalcControl instance to be wired up with gulf
-  * `storageAdapter` -- a gulf storage adapteir
-  * `ottype` -- the ottype to use, this will usually be `ot-socialcalc` from npm.
+  * `storageAdapter` -- (optional) a gulf storage adapter. Default: `gulf.MemoryAdapter`
+  * `ottype` -- (optional) the ottype to use. Default: `ot-socialcalc`
 
 ## Legal
 (c) 2016 by Marcel Klehr

src/index.js

@@ -16,12 +16,14 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 var gulf = require('gulf')
+  , socialcalcOT = require('ot-socialcalc')
   , SocialCalc = require('socialcalc')
 
 require('./socialcalc_patches')
 
 class SocialcalcDocument extends gulf.EditableDocument {
   constructor(opts) {
+    opts.ottype = opts.ottype || socialcalcOT
     super(opts)
     if (!opts.editorInstance) throw new Error('No SocialCalc instance was passed')
     this.socialcalcControl = opts.editorInstance