@otjs/plaintext
v0.2.2
Published
Operational Transformational Logic for Plain Text.
Downloads
1,828
Maintainers
Readme
@otjs/plaintext
Description
Exports Operational Transformation on Plain Text content.
Installation
To install using Pnpm (recommended):
pnpm add @otjs/ace
To install using Yarn:
yarn add @otjs/plaintext
To install using Npm:
npm i @otjs/plaintext --save
Usage
import { PlainTextOperation } from "@otjs/plaintext";
const operation = new PlainTextOperation();
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:
yarn 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
License
This project is licensed under the terms of the MIT license, see LICENSE for more details.