js-sequence-diagrams icon indicating copy to clipboard operation
js-sequence-diagrams copied to clipboard

Improve documentation

Open ghost opened this issue 7 years ago • 1 comments

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:

  • add multiple statements?
  • bind to a specific id or class element?
  • what are the options and allowed fvalues that can be passed as arguments?

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

ghost avatar Jan 23 '18 17:01 ghost

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"

bramp avatar Jan 23 '18 21:01 bramp