From ff939f124357e5602cd26bd1920be5532f21bfa5 Mon Sep 17 00:00:00 2001 From: Kevin Jahns Date: Mon, 29 Aug 2016 17:25:54 +0200 Subject: [PATCH] update docs for consistency --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f19bacf..1a073ee 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ It propagates document updates directly to all users via WebRTC. While WebRTC is * Not suited for a large amount of collaborators * WebRTC is not supported in all browsers, and some have troubles communicating with each other -We provide you with a free signaling server (it is used by default), but in production you should set up your own signaling server. You could use the [signalmaster](https://github.com/andyet/signalmaster) from &yet, which is very easy to set up. +We provide you with a free signaling server (it is used by default), but in production you should set up your own signaling server. You could use the [signalmaster](https://github.com/DadaMonad/signalmaster) from &yet, which is very easy to set up. ## Use it! -Retrieve this with bower or npm, and use it as a js library or as a custom polymer element. +Retrieve this with bower or npm. ##### NPM ``` @@ -34,14 +34,13 @@ Y({ name: 'memory' }, connector: { - name: 'webrtc', // choose the webrtc connector + name: 'webrtc', // use the webrtc connector room: 'Textarea-example-dev' }, 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'))