[DOC] Improve readme #643
[DOC] Improve readme #643
Conversation
csouchet
force-pushed
the
improve_readme
branch
2 times, most recently
from
d7bb984 to
af9d0aa
Compare
README.md
Outdated
| ``` | ||
| * Define your bpmn content | ||
| ``` | ||
| const bpmnContent = `<?xml version="1.0" encoding="UTF-8"?> |
There was a problem hiding this comment.
as an end user, I prefer not having to do such things. We should guide them about how they can do this in a better way, probably when having done process-analytics/bpmn-visualization-examples#18
In addition, we highlight bpmn-js/bpmn.io in the README whereas it is a kind of competitor for our lib
There was a problem hiding this comment.
I can change/remove some attributes of definitions.
For the people who don't know what is BPMN or want a simple example to implement faster, I think it's important to have this.
When I'm a new end user, I want to have all the information to understang the base of the library, and start my poc easly.
There was a problem hiding this comment.
I agree with you about the need for BPMN guidance, but in practise, BPMN diagram are usually loaded from an external source.
We have examples that show how to do this, both from remote sources (from miwg-test-suite) or from the code.
I would prefer we explain user to go to the examples, this will let the usage paragraph focussed on the lib and not on how to fetch/retrieve xml content which is out of the direct scope of the lib.
Have a look at bpmn-js usage, this is how it is explained and IHMO this keep the usage clearer.
var xml; // my BPMN 2.0 xml
var viewer = new BpmnJS({....
README.md
Outdated
| [](https://github.com/process-analytics/bpmn-visualization-js/releases) | ||
| [](https://github.com/process-analytics/bpmn-visualization-js/actions) | ||
| [][demo-live-environment] |
README.md
Outdated
| [](https://github.com/process-analytics/bpmn-visualization-js/releases) | ||
| [](https://github.com/process-analytics/bpmn-visualization-js/actions) |
There was a problem hiding this comment.
❓ we may probably put the build badge on its own line as it relates to the current build status
Demo and release relate to existing released materials
There was a problem hiding this comment.
I'm afraid there will too many lines of badges after.
I can put the build badge after the demo badge.
|
|
||
| ## 🎮 Demo |
There was a problem hiding this comment.
about the emoji, I am sure this make things clearer: at a first glance, this looks appealing but as we have a lot of paragraphs, it overloads the page IMHO.
But this is a matter of taste I guess, I won't veto on this at all.
There was a problem hiding this comment.
I find that, since we have a lot of paragraphs, we can find a paragraph quite easily if you scroll quickly.
We can always ask for the opinion of someone outside the project to decide ;)
There was a problem hiding this comment.
me perso I like the icons
csouchet
force-pushed
the
improve_readme
branch
3 times, most recently
from
f9bf5dc to
3419a81
Compare
csouchet
force-pushed
the
improve_readme
branch
from
3293d20 to
915ed5d
Compare
add break line at the end of the intro and remove the one between the title and the intro
tbouffard
force-pushed
the
improve_readme
branch
from
4a197bd to
f10e384
Compare
No description provided.