From 572b0d47da77320dfaf55fee04e554923910dce2 Mon Sep 17 00:00:00 2001
From: Christos <kokosias.christos@gmail.com>
Date: Mon, 28 Aug 2023 18:42:29 +0000
Subject: [PATCH] Update README.md
---
wax-table-service/README.md | 51 ++++++++++++++++++++++++++++++++++++-
1 file changed, 50 insertions(+), 1 deletion(-)
diff --git a/wax-table-service/README.md b/wax-table-service/README.md
index b8d971e91..d1cda5fd5 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(),
+ ],
--
GitLab