diff --git a/wax-table-service/README.md b/wax-table-service/README.md index b8d971e91fb0d7bf6970c3267f60dd6e2baefe9e..d1cda5fd5e41142bf193e8d0885503404dab9733 100644 --- a/wax-table-service/README.md +++ b/wax-table-service/README.md @@ -1 +1,50 @@ -## Wax table package +## Wax Table package + +Wax Table Package is a fork of [prosemirror-tables](https://github.com/ProseMirror/prosemirror-tables) with added Table Caption +funcionality + +## How to use + +### Editor's config + +``` +import { TablesService, tableEditing, columnResizing } from 'wax-table-service'; +``` + +### Styles(preferably in your layout) + +``` +import 'wax-table-service/dist/index.css' +``` + + +### Tools + +``` +MenuService: [ + { + templateArea: 'mainMenuToolBar', + toolGroups: [ + 'Tables', + ], + }, + ], + +``` + +### Start the Service + +``` + services: [ + new TablesService(), + ] +``` + +### ProseMirror Plugins + +In case you need tableEditing or columnResizing plugins add the to the array of `PmPlugins` in your editor's config + + PmPlugins: [ + tableEditing(), + columnResizing(), + ],