search

mjul / docjure

Read and write Office documents from Clojure
MIT License
622 stars 129 forks source link

Add documentation build and badge #102

Open mjul opened 2 years ago

mjul commented 2 years ago

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 commented 1 year ago

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

mjul commented 1 year ago

@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 commented 1 year ago

Thank you @mjul for this opportunity.