Link to v13 docs from README

This commit is contained in:
Kevin Jahns 2019-04-27 03:35:44 +02:00
parent 805acbb9f5
commit 584e5dfd40
3 changed files with 17 additions and 19 deletions

View File

@ -6,6 +6,8 @@ text, richtext, json, or XML. It is fairly easy to get started, as Yjs hides
most of the complexity of concurrent editing. For additional information, demos, most of the complexity of concurrent editing. For additional information, demos,
and tutorials visit [y-js.org](http://y-js.org/). and tutorials visit [y-js.org](http://y-js.org/).
:warning: Checkout the [v13 docs](./README.v13.md) for the latest advancements :warning:
### Extensions ### Extensions
Yjs only knows how to resolve conflicts on shared data. You have to choose a .. 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
@ -294,12 +296,5 @@ DEBUG_COLORS=0 DEBUG=y* node app.js > log
localStorage.debug = 'y*' localStorage.debug = 'y*'
``` ```
## Contribution
I created this framework during my bachelor thesis at the chair of computer
science 5 [(i5)](http://dbis.rwth-aachen.de/cms), RWTH University. Since
December 2014 I'm working on Yjs as a part of my student worker job at the i5.
## License ## License
Yjs is licensed under the [MIT License](./LICENSE). Yjs is licensed under the [MIT License](./LICENSE).
<yjs@dbis.rwth-aachen.de>

View File

@ -6,7 +6,7 @@ Yjs is a library for automatic conflict resolution on shared state. It implement
Yjs is **network agnostic** (p2p!), supports many existing **rich text editors**, **offline editing**, **version snapshots**, **shared cursors**, and encodes update messages using **binary protocol encoding**. Yjs is **network agnostic** (p2p!), supports many existing **rich text editors**, **offline editing**, **version snapshots**, **shared cursors**, and encodes update messages using **binary protocol encoding**.
* Chat: [https://gitter.im/y-js/yjs](https://gitter.im/y-js/yjs) * Chat: [https://gitter.im/y-js/yjs](https://gitter.im/y-js/yjs)
* Demos: [https://yjs.website/tutorial-prosemirror.html](https://yjs.website/tutorial-prosemirror.html) * Demos: [http://yjs-demos.now.sh](https://yjs.website/tutorial-prosemirror.html)
* API Docs: [https://yjs.website/](https://yjs.website/) * API Docs: [https://yjs.website/](https://yjs.website/)
### Supported Editors: ### Supported Editors:
@ -24,7 +24,7 @@ Yjs is **network agnostic** (p2p!), supports many existing **rich text editors**
Setting up the communication between clients, managing awareness information, and storing shared data for offline usage is quite a hassle. *Providers* manage all that for you and are a good off-the-shelf solution Setting up the communication between clients, managing awareness information, and storing shared data for offline usage is quite a hassle. *Providers* manage all that for you and are a good off-the-shelf solution
* [y-websockets](http://github.com/y-js/y-websockets) * [y-websockets](http://github.com/y-js/y-websockets)
* [y-webrtc](http://github.com/y-js/y-webrtc) * [y-mesh](http://github.com/y-js/y-mesh)
* [y-dat](http://github.com/y-js/y-dat) * [y-dat](http://github.com/y-js/y-dat)
@ -102,8 +102,8 @@ const sharedDocument = provider.get('my-favourites')
All content created in a shared document is shared among all peers that request the same document. Now we define types on the shared document: All content created in a shared document is shared among all peers that request the same document. Now we define types on the shared document:
```js ```js
sharedDocument.define('movie-ratings', Y.Map) sharedDocument.get('movie-ratings', Y.Map)
sharedDocument.define('favourite-food', Y.Array) sharedDocument.get('favourite-food', Y.Array)
``` ```
All clients that define `'movie-ratings'` as `Y.Map` on the shared document named `'my-favourites'` have access to the same shared type. Example: All clients that define `'movie-ratings'` as `Y.Map` on the shared document named `'my-favourites'` have access to the same shared type. Example:
@ -111,8 +111,8 @@ All clients that define `'movie-ratings'` as `Y.Map` on the shared document name
**Client 1:** **Client 1:**
```js ```js
sharedDocument.define('movie-ratings', Y.Map) sharedDocument.get('movie-ratings', Y.Map)
sharedDocument.define('favourite-food', Y.Array) sharedDocument.get('favourite-food', Y.Array)
const movies = sharedDocument.get('movie-ratings') const movies = sharedDocument.get('movie-ratings')
const food = sharedDocument.get('fovourite-food') const food = sharedDocument.get('fovourite-food')
@ -124,8 +124,8 @@ food.insert(0, ['burger'])
**Client 2:** **Client 2:**
```js ```js
sharedDocument.define('movie-ratings', Y.Map) sharedDocument.get('movie-ratings', Y.Map)
sharedDocument.define('favourite-food', Y.Map) // <- note that this definition differs from client1 sharedDocument.get('favourite-food', Y.Map) // <- note that this definition differs from client1
const movies = sharedDocument.get('movie-ratings') const movies = sharedDocument.get('movie-ratings')
const food = sharedDocument.get('fovourite-food') const food = sharedDocument.get('fovourite-food')
@ -363,8 +363,9 @@ Until [this](https://github.com/Microsoft/TypeScript/issues/7546) is fixed, the
## License and Author ## License and Author
Yjs and all related projects are [**MIT licensed**](./LICENSE). Some files also contain an additional copyright notice that allows you to copy and modify the code without shipping the copyright notice (e.g. `./provider/websocket/WebsocketProvider.js` and `./provider/websocket/server.js`) Yjs and all related projects are [**MIT licensed**](./LICENSE).
Yjs is based on the research I did as a student at the RWTH i5. I am working on Yjs in my spare time. Please help me by donating or hiring me for consulting, so I can continue to work on this project. Yjs is based on the research I did as a student at the RWTH i5. Now I am working on Yjs in my spare time.
kevin.jahns@protonmail.com kevin.jahns at protonmail.com
https://www.patreon.com/dmonad

View File

@ -1,7 +1,7 @@
{ {
"name": "yjs", "name": "yjs",
"version": "13.0.0-80", "version": "13.0.0-80",
"description": "A ", "description": "Shared Editing Library",
"main": "./dist/yjs.js", "main": "./dist/yjs.js",
"module": "./src/index.js", "module": "./src/index.js",
"sideEffects": false, "sideEffects": false,
@ -22,6 +22,8 @@
}, },
"files": [ "files": [
"dist/*", "dist/*",
"src/*",
"tests/*",
"examples/*", "examples/*",
"docs/*", "docs/*",
"README.md", "README.md",