README.md

@collaborne/remirror-extension-yjs

Realtime collaboration with yjs

Note: This is a fork for the original @remirror/extension-yjs, with some adjustments for Collaborne. Likely you want the original extension!

Installation

# npm
npm install yjs @collaborne/remirror-extension-yjs

You will also need to install your preferred YjsRealtimeProvider.

Due to the required peer dependencies this package is not included by default when installing remirror.

You will also need to install your preferred yjs protocol

# npm
npm install y-webrtc

Usage

The following code creates an instance of this extension.

import { WebrtcProvider } from 'y-webrtc';
import { Doc } from 'yjs';
import { YjsExtension } from '@collaborne/remirror-extension-yjs';

const extension = new YjsExtension({
  getProvider: () => new WebrtcProvider('global', new Doc()),
});