yonote/yjs
24
0
Fork 0
Code Pull Requests 1 Releases Activity

update npm example

Browse Source
This commit is contained in:
Kevin Jahns 2016-08-31 02:58:28 +02:00
parent 2f0216bf89
commit 330434ee24
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -58,11 +58,17 @@ You only need to include the `y.js` file. Yjs is able to automatically require m
npm install --save yjs % add all y-* modules you want to use npm install --save yjs % add all y-* modules you want to use
``` ```
When using npm, you also need to import all modules you want to use. If you don't include via script tag, you have to explicitly include all modules! (Same goes for other module systems)
``` ```
Y = require('yjs') var Y = require('yjs')
require('y-array')(Y) // add the y-array type to Yjs require('y-array')(Y) // add the y-array type to Yjs
// require('y-websockets-client')(Y) // do the same for all modules you want to use require('y-websockets-client')(Y)
require('y-memory')(Y)
require('y-array')(Y)
require('y-map')(Y)
require('y-text')(Y)
// ..
// do the same for all modules you want to use
``` ```
# Text editing example # Text editing example