README.md

@otjs/plaintext-editor

Description

Editor Client module to Synchronise Plain Text changes across multiple clients.

Installation

• To install using Pnpm (recommended):

  pnpm add @otjs/ace

• To install using Yarn:

  yarn add @otjs/plaintext-editor

• To install using Npm:

  npm i @otjs/plaintext-editor --save

Peer Dependencies

Make sure to install all the peer dependencies beforehand:

Usage

import { EditorClient, IDatabaseAdapter, IEditorAdapter } from "@otjs/plaintext-editor";

const databaseAdapter: IDatabaseAdapter = ...;
const editorAdapter: IEditorAdapter = ...;

const editorClient = new EditorClient(databaseAdapter, editorAdapter);

Note: An API documentation will be shipped along with the package. This will power intellisense in the editor of your choice.

Testing

We are using Jest to form our Unit Test Suite. Nyc (formerly known as Istanbul) is used for coverage reporting.

To run all the unit test suites in local dev environment, run the following after dependencies have been installed:

pnpm test

Reporting a Bug

Head on to Discussion section to report a bug or to ask for any feature. Use this template to make it structural and helpful for the maintainer and the contributors. Feel to add your queries about using this library as well under Q & A section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.

Changelog

See CHANGELOG for more details on what has been changed in the latest release.

Contributing

See Contributing Guidelines.

License

This project is licensed under the terms of the MIT license, see LICENSE for more details.