Merge branch 'master' into update_contributing_part_of_readme

CONTRIBUTING.md

@@ -12,7 +12,7 @@ There are many ways to contribute:
 - submitting bug reports and feature requests in the [Github Issues](https://github.com/process-analytics/bpmn-visualization-js/issues/new)
 - [writing code](CONTRIBUTING.md#code-and-documentation-changes) which can be incorporated into `bpmn-visualization` itself
 - [improving](CONTRIBUTING.md#code-and-documentation-changes) the documentation
-- improve the existing example applications to demonstrate features in `bpmn-visualization`
+- improve the existing [example applications](https://github.com/process-analytics/bpmn-visualization-examples) to demonstrate features in `bpmn-visualization`
 
 ## Code and documentation changes guidelines
 
@@ -58,8 +58,7 @@ git checkout -b 25-annotations_to_tasks
 
 #### Requirements
 
-- `Node.js` >= 12.x (may work with older versions but without any guarantee)
-- `Typescript` 3.x
+- `Node.js` 12.16.x and 14.11.x (may work with other versions but without any guarantee)
 - `Supported OS` (see the Github Build workflow for more details): Windows/Linux/MacOs
 
 #### Build

README.md

@@ -6,6 +6,7 @@
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+[![License](https://img.shields.io/github/license/process-analytics/bpmn-visualization-js?color=blue)](LICENSE)
 
 `bpmn-visualization` is a TypeScript library to visualize process execution data on [BPMN](https://www.omg.org/spec/BPMN/2.0.2/)
 diagrams with
@@ -20,8 +21,8 @@ diagrams with
 
 ## Demo
 
-The [demo environment](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html)
-let you load a BPMN file to see how the lib renders it. Various versions of the lib are available. 
+Give a try to the [__:fast_forward: demo live environment__](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html).
+The demo let you load a BPMN file to see how `bpmn-visualization` renders it. Various versions of the lib are available. 
 
 If you need BPMN examples, you can use resources from 
 - the [BPMN Model Interchange Working Group (BPMN MIWG)](http://www.omgwiki.org/bpmn-miwg)
@@ -32,10 +33,11 @@ If you need BPMN examples, you can use resources from
 
 ## Examples
 
-If you need examples about `bpmn-visualization` usage and extensibility, go to the [bpmn-visualization-examples](https://github.com/process-analytics/bpmn-visualization-examples/)
-repository.
+Want to know more about `bpmn-visualization` usage and extensibility? Have a look at the
+[__:fast_forward: live examples site__](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html).
 
-These examples are also available in the [examples live environment](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html).
+For more technical details and how-to, go to the [bpmn-visualization-examples](https://github.com/process-analytics/bpmn-visualization-examples/)
+repository.
 
 
 # Roadmap
@@ -78,4 +80,4 @@ for more details:
 
 [![statically.io logo](https://statically.io/icons/icon-96x96.png "statically.io")](https://statically.io)
 
-**[statically.io](https://statically.io)** (demo environment)
+**[statically.io](https://statically.io)** (<kbd>demo</kbd> and <kbd>examples</kbd> live environments)

docs/bpmn-support.adoc

@@ -3,7 +3,7 @@
 == Supported BPMN Elements
 :icons: font
 
-NOTE: The short term support roadmap is available in https://github.com/process-analytics/bpmn-visualization-js/milestones[Github milestones]
+NOTE: The BPMN support roadmap is available in https://github.com/process-analytics/bpmn-visualization-js/milestones[Github milestones]
 
 
 The following presents BPMN elements that can be displayed by the lib and states which is their rendering status i.e. if

docs/development/README.md

@@ -4,6 +4,6 @@ General information are available in the [Contributing Guide](../../CONTRIBUTING
 Information about the library internals are available in the [architecture folder](./docs/architecture) or in html form in the [documentation site](https://process-analytics.github.io/bpmn-visualization-js/#_architecture_and_development)
 
 Here are some tips to help during development:
-- [how to support new BPMN elements](./bpmn-support-how-to.adoc)
+- [how to support new BPMN elements](./bpmn-support-how-to.md)
 - [mxgraph version bump](./mxgraph-version-bump.md)
 - [testing](./testing.md)

docs/development/ide-configuration.md

@@ -69,17 +69,11 @@ An [AsciiDoc IntelliJ Plugin](https://plugins.jetbrains.com/plugin/7391-asciidoc
 
 Install the EditorConfig extension. A configuration file already exists in the repository so it will apply right after the extension installation.
 
-#### [Jest tests](https://github.com/jest-community/vscode-jest#how-to-get-it)
-
-To be able to run tests from VS Code, you firstly install the Jest extension, then, go to the **Run** menu of VS Code.
-You can run 2 test configurations:
+#### [Debugging TypeScript code](https://code.visualstudio.com/docs/typescript/typescript-debugging)
+The `launch.json` file is already configured to execute tests:
   - unit tests: `test:unit`
   - end to end tests: `test:e2e`
-
-If you want to use coverage, follow this tutorial: https://github.com/jest-community/vscode-jest#how-do-i-show-code-coverage
-
-#### [Debugging TypeScript code](https://code.visualstudio.com/docs/typescript/typescript-debugging)
-The `launch.json` file is already configured to execute unit & e2e tests.
+
 You can duplicate these configurations or create another, if you want/need.
 
 #### [Draw.io Diagram](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio)

docs/intro.adoc

@@ -3,8 +3,11 @@
 `bpmn-visualization` is a TypeScript library to visualize process execution data on https://www.omg.org/spec/BPMN/2.0.2/[BPMN]
 diagrams. It is in early development stages and is subject to changes prior to the `1.0.0` release.
 
-We are currently focusing on the <<supported-bpmn-elements,BPMN support>> to be able to render most of the BPMN
-elements. Then, we will work on BPMN extensions, library extension points, display options for execution data with interactive
+For now, we render the most <<supported-bpmn-elements,common BPMN elements>>. Notice that there is currently no plan to support `Conversation` and `Choreography`.
+
+We are currently focusing on the https://github.com/process-analytics/bpmn-visualization-js/milestone/18[packaging] of the library.
+
+Then, we will work on BPMN extensions, library extension points, display options for execution data with interactive
 capacities.
 
 **Supported Browsers**: Chrome, Firefox, Safari, Edge.
@@ -13,8 +16,8 @@ capacities.
 == Demo and examples
 
 === Demo
-The https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html[demo environment]
-let you load a BPMN file to see how the lib renders it. Various versions of the lib are available.
+Give a try to the https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html[**icon:forward[] demo live environment**].
+The demo let you load a BPMN file to see how `bpmn-visualization` renders it. Various versions of the lib are available.
 
 If you need BPMN examples, you can use resources from
 
@@ -25,7 +28,8 @@ If you need BPMN examples, you can use resources from
 
 
 === Examples
-If you need examples about `bpmn-visualization` usage and extensibility, go to the https://github.com/process-analytics/bpmn-visualization-examples/[bpmn-visualization-examples]
-repository.
+Want to know more about `bpmn-visualization` usage and extensibility? Have a look at the
+https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html[**icon:forward[] examples live environment**].
 
-These examples are also available in the https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html[examples live environment].
+For more technical details and how-to, go to the https://github.com/process-analytics/bpmn-visualization-examples/[bpmn-visualization-examples]
+repository.