mirror of
https://github.com/cudr/slate-collaborative.git
synced 2024-10-27 20:34:06 +00:00
Update README.md
This commit is contained in:
parent
d30c5dd19e
commit
744e22fdca
@ -1,13 +1,10 @@
|
|||||||
# slate-collaborative
|
# slate-collaborative [Demo](https://slate-collaborative.herokuapp.com/)
|
||||||
slatejs collaborative plugin & microservice
|
slatejs collaborative plugin & microservice
|
||||||
|
|
||||||
A little experiment for co-editing.
|
A little experiment for co-editing.
|
||||||
|
|
||||||
Based on idea of https://github.com/humandx/slate-automerge
|
Based on idea of https://github.com/humandx/slate-automerge
|
||||||
|
|
||||||
Check the [Demo](https://slate-collaborative.herokuapp.com/)
|
|
||||||
|
|
||||||
|
|
||||||
# API
|
# API
|
||||||
|
|
||||||
## Client
|
## Client
|
||||||
@ -46,7 +43,7 @@ const connection = new CollaborativeBackend(options)
|
|||||||
### options:
|
### options:
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
entry: number // port or Server for listen io connection
|
entry: number | Server // port or Server for listen io connection
|
||||||
connectOpts?: SocketIO.ServerOptions
|
connectOpts?: SocketIO.ServerOptions
|
||||||
defaultValue?: ValueJSON // default value
|
defaultValue?: ValueJSON // default value
|
||||||
saveTreshold?: number // theshold of onDocumentSave callback execution
|
saveTreshold?: number // theshold of onDocumentSave callback execution
|
||||||
|
Loading…
Reference in New Issue
Block a user