Skip to content

Commit

Permalink
docs: present the library as less "experimental" than before (#160)
Browse files Browse the repository at this point in the history
We received several comments indicating that the term "experimental"
might prevent people from evaluating the library. They might see it as
being at too early a stage of development.

We want to increase the dissemination and use of the library as much as
possible. That's why we've removed the word "experimental" from the
wording.
  • Loading branch information
tbouffard authored Oct 27, 2023
1 parent 9e4f24d commit 4169028
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 14 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1 align="center">bpmn-visualization experimental add-ons</h1>
<h1 align="center">bpmn-visualization add-ons</h1>
<div align="center">
<p align="center">
<a href="https://npmjs.org/package/@process-analytics/bv-experimental-add-ons">
Expand Down Expand Up @@ -27,16 +27,14 @@
</div>
<br>

Experimental add-ons for [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js).

## 🔆 Presentation

## 🔆 Project Status

`bv-experimental-add-ons` is at an early stage of development.

It provides new experimental features for `bpmn-visualization`.
`bv-experimental-add-ons` offers new functionalities to [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) in the form of add-ons.

`bv-experimental-add-ons` is being actively developed.
Before the release of version `1.0.0`, there may be some breaking changes.

<!--
We avoid these as much as possible, and carefully document them in the release notes.
As far as possible, we maintain compatibility for some minor versions.
Expand Down
4 changes: 2 additions & 2 deletions packages/addons/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bpmn-visualization experimental add-ons
# bpmn-visualization add-ons

Experimental add-ons for [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js).
`bv-experimental-add-ons` offers new functionalities to [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) in the form of add-ons.


## 📌 Usage
Expand Down
2 changes: 1 addition & 1 deletion packages/demo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Demo for "bpmn-visualization experimental add-ons"
# Demo for "bpmn-visualization add-ons"

The demo has been initialized using [bpmn-visualization-demo-template](https://github.com/process-analytics/bpmn-visualization-demo-template/).

Expand Down
8 changes: 4 additions & 4 deletions packages/demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/assets/logo.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>bv-experimental-add-ons</title>
<title>bpmn-visualization add-ons</title>
<link rel="stylesheet" href="/src/assets/index.css" type="text/css">
</head>
<body>
<header>
<img src="/assets/logo.svg" id="logo" alt="The Process Analytics project logo" class="logo">
<h1>bv-experimental-add-ons</h1>
<h1>bpmn-visualization add-ons</h1>
</header>
<section class="presentation">
Welcome to <code>bv-experimental-add-ons</code>.
Welcome to <code>bpmn-visualization add-ons</code>.
<p>
<code>bv-experimental-add-ons</code> provides new experimental features for <a href="https://github.com/process-analytics/bpmn-visualization-js" target="_blank" rel="noopener">bpmn-visualization</a>.
It provides new features for <a href="https://github.com/process-analytics/bpmn-visualization-js" target="_blank" rel="noopener">bpmn-visualization</a>.
<p>

<div class="source-code">
Expand Down

0 comments on commit 4169028

Please sign in to comment.