Rewrite README with usage, status and version guidance - #88
Merged
Conversation
Adds a dependency snippet, the Java baseline and documentation links, none of which were present. The substantial addition is the 3.x versus 4.x guidance. The two lines are not interchangeable - 4.x requires Java 17 and works only under Maven 4, while 3.x is the straight extraction from plexus-utils 4 and works under both - and choosing wrong is a bad afternoon. The README described the split but never said which line to take. 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 (codehaus-plexus/plexus-archiver#438, codehaus-plexus/plexus-i18n#37, codehaus-plexus/plexus-utils#332).
The old README explained how the split happened — the history of the extraction from
plexus-utils— but never answered the question people actually arrive with: which line do I take?That matters more here than in most repos, because the two are not interchangeable:
3.x4.xTaking
4.xwhen you needed3.xfails at runtime under Maven 3, and nothing in the README said so. It now leads with that table, and adds the sentence I would give someone who turned up confused:Also adds the dependency snippet and the Java baseline — this was one of only two READMEs in the org that mentioned a Java version at all, and it did so in prose rather than anywhere findable.
Ran
mvn spotless:apply.