From 94ed16ca980f338486325d4d454416898d5baf4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Zag=C3=B3rski?= Date: Mon, 4 Jul 2022 08:25:31 +0200 Subject: [PATCH 1/2] Added manual test information to the readme file. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2e53a8c1e..a158bd16d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ Warning: This is an experimental plugin that comes with no support, use it at yo This package contains a Mermaid feature for CKEditor 5. +## CKEditor 5 Mermaid - Running manual test + +You can test all of the functionalities of the CKEdtitor 5 mermaid feature with the manual test sample. + +Having the build in place, it's enough to execute the following at the root of your local clone of the project: + +``` +yarn start +``` + ## License See [LICENSE.md](LICENSE.md) file. From a3481580c5033d330d409d4004ab769c474082ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dariusz=20Jarz=C4=99bski?= Date: Tue, 19 Jul 2022 14:15:14 +0200 Subject: [PATCH 2/2] Minor rewording. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a158bd16d..04c56d87e 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ This package contains a Mermaid feature for CKEditor 5. ## CKEditor 5 Mermaid - Running manual test -You can test all of the functionalities of the CKEdtitor 5 mermaid feature with the manual test sample. +You can test all of the features of the `ckeditor5-mermaid` plugin with the manual test sample. -Having the build in place, it's enough to execute the following at the root of your local clone of the project: +After installing dependencies it's enough to execute the following script at the root of your local clone of the project: ``` yarn start @@ -21,4 +21,4 @@ See [LICENSE.md](LICENSE.md) file. ### Trademarks -**CKEditor** is a trademark of [CKSource](https://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders. \ No newline at end of file +**CKEditor** is a trademark of [CKSource](https://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.