diff --git a/README.md b/README.md index 96c85991..d150f762 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ For additional information, demos, and tutorials visit [y-js.org](http://y-js.or ### Extensions Yjs only knows how to resolve conflicts on shared data. You have to choose a .. -* *Connector* - a communication protocol that propagates changes to the clients +* *Connector* - a communication protocol that propagates changes to the clients * *Database* - a database to store your changes * one or more *Types* - that represent the shared data @@ -47,7 +47,7 @@ Connectors, Databases, and Types are available as modules that extend Yjs. Here |-----------|-------------------| |[y-element](http://y-js.org/y-element/) | Yjs Polymer Element | -## Use it! +## Use it! Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs). ### Bower @@ -113,7 +113,7 @@ Here is a simple example of a shared textarea name: 'webrtc', // use webrtc connector // name: 'websockets-client' // name: 'xmpp' - room: 'my-room' // clients connecting to the same room share data + room: 'my-room' // clients connecting to the same room share data }, sourceDir: '/bower_components', // location of the y-* modules (browser only) share: { @@ -122,7 +122,7 @@ Here is a simple example of a shared textarea }).then(function (y) { // The Yjs instance `y` is available // y.share.* contains the shared types - + // Bind `y.share.textarea` to `