From 9175faee5db878b6569d3ca138a5cadc8a330af9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Souchet=20C=C3=A9line?=
<4921914+csouchet@users.noreply.github.com>
Date: Fri, 7 Jun 2024 16:53:54 +0200
Subject: [PATCH] docs: improve the library description (#2184)
In the Readme & the User documentation
---------
Co-authored-by: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
---
README.md | 8 ++++----
docs/users/intro.adoc | 7 +++++--
2 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index f98f434708..55b9dc086b 100644
--- a/README.md
+++ b/README.md
@@ -35,11 +35,11 @@
-`bpmn-visualization` is a TypeScript library for visualizing process execution data on [BPMN](https://www.omg.org/spec/BPMN/2.0.2/) diagrams with:
-- additional display options for execution data (highlight some transitions, counters, and more)
-- interactive capacities (mouse hover, click)
+`bpmn-visualization` is a TypeScript library for visualizing process execution data on [BPMN](https://www.omg.org/spec/BPMN/2.0.2/) diagrams, with simplicity.
-
+Based on the customization capability, it provides a set of diagram visualization features that includes additional display options for execution data (_highlighting of some elements_, _adding customizable overlays_, and more) as well as personalized interactive capabilities (_mouse hover_, _click_, and more).
+
+We hope it will help you to create applications for process visualization and analysis 🙂
## 🎮 Demo and examples
diff --git a/docs/users/intro.adoc b/docs/users/intro.adoc
index 4fcd979019..676368e8e9 100644
--- a/docs/users/intro.adoc
+++ b/docs/users/intro.adoc
@@ -1,2 +1,5 @@
-`bpmn-visualization` is a TypeScript library for visualizing process execution data on https://www.omg.org/spec/BPMN/2.0.2/[BPMN]
-diagrams.
+`bpmn-visualization` is a TypeScript library for visualizing process execution data on https://www.omg.org/spec/BPMN/2.0.2/[BPMN] diagrams, with simplicity.
+
+Based on the customization capability, it provides a set of diagram visualization features that includes additional display options for execution data (_highlighting of some elements_, _adding customizable overlays_, and more) as well as personalized interactive capabilities (_mouse hover_, _click_, and more).
+
+We hope it will help you to create applications for process visualization and analysis 🙂