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

updated README

Browse Source
This commit is contained in:
Kevin Jahns 2014-08-19 21:22:43 +02:00
parent 671174e17f
commit e6b5706aad
3 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -6,8 +6,8 @@ Yatta! provides similar functionality as [ShareJs](https://github.com/share/Shar
but does not require you to understand how the internals work. The predefined data structures provide a simple API to access your shared data structures. but does not require you to understand how the internals work. The predefined data structures provide a simple API to access your shared data structures.
Predefined data structures: Predefined data structures:
* Text - [Collaborative Text Editing Example](http://dadamonad.github.io/Yatta/examples/TextEditing/) and [example code](./examples/TextEditing/) * Text - [Collaborative Text Editing Example](http://dadamonad.github.io/Yatta/examples/TextEditing/) and [Source](./examples/TextEditing/)
* Json - [example code](./examples/Json/) * Json - [Tutorial](./examples/PeerJs-Json/)
* XML (coming soon) * XML (coming soon)
Unlike other frameworks, Yatta! supports P2P message propagation and is not bound to a specific communication protocol. Unlike other frameworks, Yatta! supports P2P message propagation and is not bound to a specific communication protocol.

2
examples/PeerJs-Json/README.md
View File

@ -115,7 +115,7 @@ Apply a 'addProperty' - listener to a JsonType.
console.log("Property '" + property_name + "' was created!"); console.log("Property '" + property_name + "' was created!");
}; };
yatta.on('addProperty', addProperty); yatta.on('addProperty', addProperty);
yatta.val('q', {z: 7}); // Property 'newString' was created! yatta.val('new', {z: 7}); // Property 'new' was created!
``` ```

5
examples/PeerJs-Json/index.js
View File

@ -17,7 +17,8 @@ A working widget implementation is [IwcJson.xml](./IwcJson.xml) and the js-file
The PeerJs Framework requires an API key, or you need to set up your own PeerJs server. The PeerJs Framework requires an API key, or you need to set up your own PeerJs server.
Get an API key from the Website. Get an API key from the Website.
The first parameter of `createPeerJsConnector` is the options object in PeerJs. The first parameter of `createPeerJsConnector` is forwarded as the options object in PeerJs.
Therefore, you may also specify the server/port here.
*/ */
var yatta, yattaHandler; var yatta, yattaHandler;
Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){ Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
@ -87,7 +88,7 @@ Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
console.log("Property '" + property_name + "' was created!"); console.log("Property '" + property_name + "' was created!");
}; };
yatta.on('addProperty', addProperty); yatta.on('addProperty', addProperty);
yatta.val('q', {z: 7}); // Property 'newString' was created! yatta.val('new', {z: 7}); // Property 'new' was created!
/** /**
Apply a 'change' - listener to a JsonType. Apply a 'change' - listener to a JsonType.