Rewrite README with usage, status and version guidance - #181
Merged
Conversation
The README was badges, a 2015 line saying the canonical repository is this one, and the site-publishing recipe. Nothing about what the library does or how to depend on it. Adds a description, maintenance status, a dependency snippet, the Java baseline and documentation links, and notes that most consumers arrive through plexus-archiver. The publish recipe is dropped: it now lives once in RELEASING.md instead of being restated per repository. 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,
The current master is now at https://github.com/codehaus-plexus/plexus-io— shown to a reader already on that page — and a site-publishing recipe. Nothing saying what the library does.After: what it is, status, dependency snippet, Java baseline, docs links.
One addition worth calling out: the README now says that most people meet this through
plexus-archiver. That answers "why is this on my classpath", which is how the majority of readers arrive at a transitive dependency.The publish recipe is removed rather than corrected — it now lives once in RELEASING.md instead of being restated, inconsistently, in six READMEs.
Ran
mvn spotless:apply.