Rewrite README with usage, status and version guidance - #134
Merged
Conversation
Adds what the library does, a dependency snippet, the Java 17 baseline for 4.x, and the note that plexus-cipher was absorbed here in 4.x and is archived. Points Maven users at the encryption guide rather than at this artifact, and asks for vulnerabilities to be reported privately, which matters more here than elsewhere. Drops the 2015 'current master is now at' line and the site-publishing recipe - the latter did not work anyway, see #132. 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.
Adds the usual: description, status, dependency snippet, Java baseline, docs links. Three things specific to this repo:
Java 17. This is one of only two projects here that needs it rather than Java 8, and the README did not say so.
plexus-cipherwas absorbed. The cipher implementation lives here as of 4.x (Cipher,internal/cipher), and the standalone artifact is archived. Anyone still depending onplexus-ciphershould know that.Maven users are pointed elsewhere. The old README linked the encryption guide with no framing; it now says plainly that if you are a Maven user rather than a tool author, the guide is what you want and this artifact is the implementation behind it.
Since this handles credentials, the README also asks for vulnerabilities to be reported privately. That reads as boilerplate on most repos; here it is the point.
The site-publishing recipe is dropped rather than corrected — it never worked in this repo (#132, fixed in #133).
Ran
mvn spotless:apply.