Add javadoc.io link and badge to Readme #180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Regarding #179. While OS-Lib is small and the Readme has the cookbook already, it'd also be helpful to have some API documentation to search through. This PR adds a link to https://javadoc.io/doc/com.lihaoyi/os-lib_3 as well as a badge at the top of the Readme. I only put in a link to the docs for the
os-lib_3artifact since I figured it'd be the same for Scala 3 as well as Scala 2.13, but if not, I guess two links, one for Scala 3 and one for Scala 2, can be put in.