-
Notifications
You must be signed in to change notification settings - Fork 37
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
Link Javadoc from README (prominently) #145
Comments
@nkuehn it's there actually: https://github.com/commercetools/commercetools-sync-java#commercetools-sync |
Probably not prominent enough - at least I oversaw it. |
@nkuehn https://github.com/commercetools/commercetools-sync-java#commercetools-sync It's now added as a badge in the README :)
The dev contributing stuff are moved away now from the README. They are now in the CONTRIBUTING. So that the README is only focused on the users of the lib rather than its devs. |
Closing this issue now since it should be addressed by 5d72274. |
Description
To make it easier to start with, prominently link to the JavaDoc from the README.md
e.g. like done in the JVM SDK https://github.com/commercetools/commercetools-jvm-sdk
Context
We learnt this "the hard way" in the JVM SDK - if you don't put a very prominent link nobody reads al the hard work you have put in the JavaDocs. Had to send out the link separately to everybody.
The text was updated successfully, but these errors were encountered: