doc: explain the maxGraph mission and status in the README #93
Conversation
…o use it First present what the lib does and the project status. Provide a code example and a gif to let potential users see the rendering at a glance. Remove inaccurate content and refresh the project history.
| // Adds cells to the model in a single step | ||
| graph.batchUpdate(() => { | ||
| const vertex01 = graph.insertVertex(parent, null, 'a regular rectangle', 10, 10, 100, 100); | ||
| const vertex02 = graph.insertVertex(parent, null, 'a regular ellipse', 350, 90, 50, 50, <CellStyle>{shape: 'ellipse', fillColor: 'orange'}); |
There was a problem hiding this comment.
ℹ️ the method signature in the type is currently: insertVertex: (...args: any[]) => Cell;
So, cast to CellStyle to get code assist.
|
A good start, would like to add something which states what mxGraph/maxGraph does too. Putting this together on the train but will revise this later:
Let me know if the above sounds ok to you, or if it could be improved. I think the wording could be made smoother. |
I like the idea to have a more detailed description of the lib and your proposal sounds good to me 💯 |
|
@mcyph I have integrated in the README the proposal you made in #93 (comment) |
|
I am going to merge this PR: it is much more accurate than the current one and it can be improved later. |
Summary
The README is the main entry point of the lib. It should provide the main information about the project and should attract potential users.
Currently, as noticed by @mcyph in #85 (comment) is a mix of technical information and outdated sentences about the good old mxGraph.
This Pull Request is a first attempt to improve things. In short
I am sure that the layout and the style can be improved, but IMHO, it is a good start that we will able to improve iteratively later.
Description for the changelog
doc: explain what maxGraph does an the project status in the README
Other info
Since I am not a native English speaker, I would be happy if someone could improve the wording 😸 .
This contribution is done under the terms of the Apache 2.0 license as stated in https://www.apache.org/licenses/LICENSE-2.0.