Create README.md

README.md

@@ -0,0 +1,63 @@
+# slate-collaborative
+slatejs collaborative plugin & microservice
+
+A little experiment for co-editing.
+
+Based on idea https://github.com/humandx/slate-automerge
+
+Watch the demo
+
+
+# API
+
+## Client
+
+Use it as a simple slatejs plugin
+
+```
+import ColaborativeClient from '@slate-collaborative/client'
+
+const plugins = [ColaborativeClient(options)]
+```
+
+### options:
+```
+{
+  url?: string // url to open connection
+  connectOpts?: SocketIOClient.ConnectOpts // socket.io-client options
+  cursorAnnotationType?: string // type string for cursor annotations
+  annotationDataMixin?: Data // any data passed to cursor annotation
+  renderPreloader?: () => ReactNode // optional preloader render
+  renderCursor?: (data: Data) => ReactNode | any // option custom cursor render
+  onConnect?: (connection: Connection) => void // connect callback
+  onDisconnect?: (connection: Connection) => void // disconnect callback
+}
+```
+
+## Backend
+```
+const CollaborativeBackend = require('@slate-collaborative/backend')
+
+const connection = new CollaborativeBackend(options)
+```
+
+### options:
+```
+{
+  port: number
+  connectOpts?: SocketIO.ServerOptions
+  defaultValue?: ValueJSON
+  saveTreshold?: number
+  cursorAnnotationType?: string
+  onAuthRequest?: (
+    query: Object,
+    socket?: SocketIO.Socket
+  ) => Promise<boolean> | boolean
+  onDocumentLoad?: (
+    pathname: string,
+    query?: Object
+  ) => ValueJSON | null | false | undefined
+  onDocumentSave?: (pathname: string, json: ValueJSON) => Promise<void> | void
+}
+```
+