bramp / js-sequence-diagrams

Draws simple SVG sequence diagrams from textual representation of the diagram
https://bramp.github.io/js-sequence-diagrams/
BSD 2-Clause "Simplified" License
7.81k stars 1.08k forks source link

Improve documentation #187

Open ghost opened 6 years ago

ghost commented 6 years ago

Hi,

While the demos on the website work. There is too little documentation on the library.

For instance you show the following code: var d = Diagram.parse("A->B: Does something"); How do I:

In other words, using the library should be easy without having to browse code.

bramp commented 6 years ago

Thanks for your feedback. I'll certainly look where I can improve, but I think #2 and #3 are answered here: https://github.com/bramp/js-sequence-diagrams#usage ? Is there some way I can make that clearer? Just for the record, #1 is solved by using a multi-line string "A->B: Does something\nB->C: Something else"