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

Add documentation build and badge #102

Open
mjul opened this issue Oct 6, 2022 · 3 comments · May be fixed by #108
Open

Add documentation build and badge #102

mjul opened this issue Oct 6, 2022 · 3 comments · May be fixed by #108

Comments

@mjul
Copy link
Owner

mjul commented Oct 6, 2022

Add Cljdoc link and badge to README to make API documentation easily accessible.

See Cljdoc for details on how to set this up.

https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#basic-setup

@EleekaN
Copy link

EleekaN commented Nov 21, 2022

Hi @mjul , I think I can do this.
Under which section in readme, you want the link and the badge added?

@mjul
Copy link
Owner Author

mjul commented Nov 23, 2022

@EleekaN That's great, just place it where you think it is most relevant. Maybe before the examples in the Usage section?

Also, when you send a pull request, don't forget to add your name to the contributor list in the README file.

Thanks again.

@EleekaN
Copy link

EleekaN commented Nov 23, 2022

Thank you @mjul for this opportunity.

@mjul mjul linked a pull request Nov 23, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@mjul @EleekaN and others