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

Expose functionality as a library #1

Open
stathissideris opened this issue May 31, 2020 · 0 comments
Open

Expose functionality as a library #1

stathissideris opened this issue May 31, 2020 · 0 comments

Comments

@stathissideris
Copy link

This is a useful project and I think it would benefit the Clojure community if we had access to it as a library. In order to do this you could take the following steps:

  1. Explain in the readme which function(s) from which namespace a developer should call in order to render a sequence diagram
  2. Explain in the readme what the expected input of the function in question looks like. I know that there is already a DSL which is used as input when the diagram is generated based on a file, but Clojure devs would find it useful to be able to pass a data structure instead of a file/string as input, so this part of the documentation should explain what this data strucure looks like.
  3. Add a deps.edn file in addition to `project.clj. This will allow other Clojure projects to include documan as a library based on git URLs without you having to publish it manually. Read this guide on how to do it: https://clojure.org/guides/deps_and_cli
  4. For Leiningen users, you can publish documan to the Clojars repo, see https://github.com/clojars/clojars-web/wiki/Pushing

I hope that's clear enough!

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