Rewrite README with usage, status and version guidance - #37
Merged
Conversation
The README was badges plus one line saying the canonical repository is this one. Nothing about what the component does, how to depend on it, or which Java version it needs. Adds a description, maintenance status, the 1.0-beta to 1.1.0 version story, a dependency snippet, a usage example checked against I18N.java, the Java baseline, and documentation links. Names the Maven reporting plugins that consume this, verified by searching Apache poms rather than from memory. Same skeleton as codehaus-plexus/plexus-archiver#438. Part of codehaus-plexus/.github#58
Without one the generated site homepage falls back to the parent POM's description. The live site currently reads, in full: About Plexus I18N Component The Plexus project provides a full software stack for creating and executing software projects. which is both uninformative and no longer true. Part of codehaus-plexus/.github#58
This was referenced Aug 8, 2026
This was referenced Aug 8, 2026
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. Second pilot of the README skeleton — see codehaus-plexus/plexus-archiver#438 for the first and the rationale.
Two pilots deliberately: archiver is our busiest artifact, this one is quiet. If the skeleton only works for the busy repos it's the wrong skeleton.
Before
Badges, plus "The canonical git repository is located at https://github.com/codehaus-plexus/plexus-i18n" — shown to someone already looking at that repository. Eight lines, none of which say what the component does.
After
The same sections as the archiver PR: what it is → status → coordinates → usage → requirements → docs → contributing.
Two things worth calling out, both of which only came up because this is a quiet repo:
The status section earns its place here more than in archiver. A reader looking at this repo sees a commit history of nothing but Dependabot bumps and reasonably wonders whether it's abandoned. It isn't — the API is small and finished. Saying "maintained, but quiet by design — expect dependency updates rather than features" is more honest than letting people infer from commit dates, and it's the kind of thing we currently document nowhere.
The version story. This component sat on
1.0-beta-*for about twenty years, and1.0.0/1.1.0landed in November 2025. Anyone still on a beta has no way to know whether upgrading is a rename or a rewrite. It's a rename, so the README now says so.Verified, not assumed
I18N.java— all threegetStringoverloads exist as shown, andDefaultI18Nis@Named @Singleton, so the@Injectexample is real.gh api search/codeacrossorg:apachereturns 14 poms depending on this artifact; the named five aremaven-project-info-reports-plugin,maven-surefire-report-plugin,maven-checkstyle-plugin,maven-pmd-pluginandmaven-site-plugin. That seemed worth stating outright — it answers "why is this on my classpath", which is how most people arrive here.Open questions
Same two as the archiver PR — the hardcoded version in the snippet, and the status wording. Answer them there and I'll apply the outcome to both plus the remaining 15.