Skip to content

Commit

Permalink
update docs for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
dmonad committed Aug 29, 2016
1 parent 778f805 commit d2a8e52
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,19 @@ bower install y-websockets-client --save
```
Y({
db: {
name: 'memory'
name: 'memory' // use the memory db adapter
},
connector: {
name: 'websockets-client', // choose the websockets-client connector
name: 'websockets-client', // use the websockets-client connector
room: 'Textarea-example-dev',
// socket: io('http://localhost:1234') // Pass socket.io object to use
// url: http://localhost:1234 // the connection endpoint (see y-websockets-server)
// if `url` is not set, the default connection endpoint is chosen
// (provided by the i5 chair of informatics, RTWH University)
// (provided by the i5 chair of computer science, RTWH University)
},
sourceDir: '/bower_components', // location of the y-* modules
share: {
textarea: 'Text' // y.share.textarea is of type Y.Text
}
// types: ['Richtext', 'Array'] // optional list of types you want to import
}).then(function (y) {
// bind the textarea to a shared text element
y.share.textarea.bind(document.getElementById('textfield'))
Expand Down

0 comments on commit d2a8e52

Please sign in to comment.