From 7c842efd529794dd04fa6602b2dc784592dfc3c1 Mon Sep 17 00:00:00 2001 From: DadaMonad Date: Tue, 27 Jan 2015 19:32:51 +0000 Subject: [PATCH] updated README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a9696ebf..ef854ce4 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ -# ![Yatta!](https://dadamonad.github.io/files/layout/y_logo.png) +# ![Yatta!](https://dadamonad.github.io/files/layout/yjs.svg) + [![Build Status](http://layers.dbis.rwth-aachen.de/jenkins/job/Yatta/badge/icon)](http://layers.dbis.rwth-aachen.de/jenkins/job/Yatta/) - -yjs is a framework for optimistic concurrency control and automatic conflict resolution on arbitrary data types. The framework implements a new OT-like concurrency algorithm and provides similar functionality as [ShareJs] and [OpenCoweb]. yjs was designed to take away the pain from concurrently editing complex data types like Text, Json, and XML. You can find some applications for this framework [here](https://dadamonad.github.io/yjs/examples/). +Yjs is a framework for optimistic concurrency control and automatic conflict resolution on arbitrary data types. The framework implements a new OT-like concurrency algorithm and provides similar functionality as [ShareJs] and [OpenCoweb]. Yjs was designed to take away the pain from concurrently editing complex data types like Text, Json, and XML. You can find some applications for this framework [here](https://dadamonad.github.io/yjs/examples/). In the future, we want to enable users to implement their own collaborative types. Currently we provide data types for * Text * Json * XML -Unlike other frameworks, yjs supports P2P message propagation and is not bound to a specific communication protocol. Therefore, yjs is extremely scalable and can be used in a wide range of application scenarios. +Unlike other frameworks, Yjs supports P2P message propagation and is not bound to a specific communication protocol. Therefore, Yjs is extremely scalable and can be used in a wide range of application scenarios. We support several communication protocols as so called *Connectors*. You find a bunch of Connectors in the [y-connectors](https://github.com/rwth-acis/y-connectors) repository. Currently supported communication protocols: * [XMPP-Connector](http://xmpp.org) - Propagates updates in a XMPP multi-user-chat room * [WebRTC-Connector](http://peerjs.com/) - Propagate updates directly with WebRTC * [IWC-Connector](http://dbis.rwth-aachen.de/cms/projects/the-xmpp-experience#interwidget-communication) - Inter-widget Communication -You can use yjs client-, and server- side. You can get it as via npm, and bower. We even provide a polymer element for yjs! +You can use Yjs client-, and server- side. You can get it as via npm, and bower. We even provide a polymer element for Yjs! The theoretical advantages over similar frameworks are support for * .. P2P message propagation and arbitrary communication protocols @@ -52,7 +52,7 @@ Y = require("yjs"); ``` ## Status -yjs is still in an early development phase. Don't expect that everything is working fine. +Yjs is still in an early development phase. Don't expect that everything is working fine. But I would become really motivated if you gave me some feedback :) ([github](https://github.com/rwth-acis/yjs/issues)). ### Current Issues @@ -66,7 +66,7 @@ Please report _any_ issues to the [Github issue page](https://github.com/rwth-ac I would appreciate if developers give me feedback on how _convenient_ the framework is, and if it is easy to use. Particularly the XML-support may not support every DOM-methods - if you encounter a method that does not cause any change on other peers, please state function name, and sample parameters. However, there are browser-specific features, that Y won't support. ## License -yjs is licensed under the [MIT License](./LICENSE.txt). +Yjs is licensed under the [MIT License](./LICENSE.txt). [ShareJs]: https://github.com/share/ShareJS [OpenCoweb]: https://github.com/opencoweb/coweb