diff --git a/README.md b/README.md index 0d6babe..0ce3e75 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,27 @@ -# React + TypeScript + Vite +# @tolgee/editor package -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +Package which contains codemirror and other parsing tools plugin for Tolgee format, so it can be used in Tolgee Platform and also in SDKs. -Currently, two official plugins are available: +## Setup locally -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh - -## Expanding the ESLint configuration +Install dependencies +``` +npm install +``` -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: +Run UI - runs a playground UI, where you can check the example editor +``` +npm run dev +``` -- Configure the top-level `parserOptions` property like this: +### Build the package -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -} +``` +npm run build ``` -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list +If you want to test the package locally, you can also build in watch mode + +``` +npm run build:watch +``` \ No newline at end of file