gulf-editor-socialcalc/README.md

Gulf bindings for the socialcalc spreadsheet editor

# gulf-editor-socialcalc
[Gulf](https://github.com/gulf/gulf) bindings for the [socialcalc](https://npmjs.org/package/socialcalc) spreadsheet editor.
It utilizes the [ot-socialcalc](https://github.com/marcelklehr/ot-socialcalc) OT type.

 * Compatible with gulf v5 only (For gulf v4, you may find v0.1.x to work.)

## Install

```
npm install --save gulf-editor-codemirror
```

## Usage

```js
const SocialcalcDocument = require('gulf-editor-socialcalc')

var doc = new SocialcalcDocument({
  editorInstance: socialcalcControl
})

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` -- (optional) a gulf storage adapter. Default: `gulf.MemoryAdapter`
  * `ottype` -- (optional) the ottype to use. Default: `ot-socialcalc`

## Legal
(c) 2016 by Marcel Klehr

Mozilla Public License 2.0

`socialcalc_patches.js` is licensed under CC0 by Audrey Tang.