Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #187

Open
ghost opened this issue Jan 23, 2018 · 1 comment
Open

Improve documentation #187

ghost opened this issue Jan 23, 2018 · 1 comment

Comments

@ghost
Copy link

ghost commented Jan 23, 2018

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.

@bramp
Copy link
Owner

bramp commented Jan 23, 2018

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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant