Skip to content

Commit

Permalink
docs: improve the library description (#2184)
Browse files Browse the repository at this point in the history
In the Readme & the User documentation

---------

Co-authored-by: Thomas Bouffard <[email protected]>
  • Loading branch information
csouchet and tbouffard authored Jun 7, 2024
1 parent debbd03 commit 9175fae
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@
</div>
<br>

`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.

<br>
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
Expand Down
7 changes: 5 additions & 2 deletions docs/users/intro.adoc
Original file line number Diff line number Diff line change
@@ -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 🙂

0 comments on commit 9175fae

Please sign in to comment.