Rewrite README with usage, status and version guidance - #123
Merged
Conversation
The README was badges and a line saying the canonical repository is this one. Nothing about what the component does. Adds a description, status, a dependency snippet, a usage example checked against ResourceManager and FileResourceLoader, the Java baseline and documentation links. Part of codehaus-plexus/.github#58
This file contains hidden or 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
1 participant
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.
Part of codehaus-plexus/.github#58. Same skeleton as the merged pilots.
Before: badges and
The canonical git repository is located at …, nine lines total.The addition that matters is why you would reach for this:
That is the actual use case — it is how
maven-checkstyle-pluginand friends resolve a ruleset — and neither the README nor the POM description conveyed it.The example is checked against the real API:
addSearchPath,getResourceAsInputStreamandgetResourceAsFileall exist as shown onResourceManager, andFileResourceLoader.IDis the loader id.Ran
mvn spotless:apply.