diff --git a/README.md b/README.md index 39d2b094..d3e2dd54 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,14 @@ suited for even large documents. * Discuss: [https://discuss.yjs.dev](https://discuss.yjs.dev) * Benchmarks: [https://github.com/dmonad/crdt-benchmarks](https://github.com/dmonad/crdt-benchmarks) +* Podcast **"Yjs Deep Dive into real time collaborative editing solutions":** https://www.tag1consulting.com/blog/deep-dive-real-time-collaborative-editing-solutions-tagteamtalk-001-0 +* Podcast **"Google Docs-style editing in Gutenberg with the YJS framework":** https://publishpress.com/blog/yjs/ :warning: This is the documentation for v13 (still in alpha). For the stable v12 release checkout the [v12 docs](./README.v12.md) :warning: +:construction_worker_woman: If you are looking for professional support to build collaborative or distributed applications ping us at . + ## Table of Contents * [Overview](#Overview) @@ -70,18 +74,15 @@ manage all that for you and are the perfect starting point for your collaborative app.
+
y-webrtc
+
+Propagates document updates peer-to-peer using WebRTC. The peers exchange signaling data over signaling servers. Publically available signaling servers are available. Communication over the signaling servers can be encrypted by providing a shared secret, keeping the connection information and the shared document private. +
y-websocket
A module that contains a simple websocket backend and a websocket client that connects to that backend. The backend can be extended to persist updates in a leveldb database. -
-
y-mesh
-
-[WIP] Creates a connected graph of webrtc connections with a high -strength. It -requires a signaling server that connects a client to the first peer. But after -that the network manages itself. It is well suited for large and small networks.
y-dat
@@ -97,7 +98,7 @@ hypercores and y-dat listens to changes and applies them to the Yjs document. Install Yjs and a provider with your favorite package manager: ```sh -npm i yjs@13.0.0-97 y-websocket@1.0.0-6 +npm i yjs@13.0.0-103 y-websocket@1.0.0-6 ``` Start the y-websocket server: