From db177b9ca6a6ea9de8e5dae8f0b8383108f63737 Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 8 Aug 2026 18:52:32 +0200 Subject: [PATCH 1/2] Rewrite README with usage, status and version guidance 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 --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 14ad8e7..abe477a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,54 @@ -Plexus-I18N -=========== +# Plexus I18N -[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/codehaus-plexus/plexus-i18n.svg?label=License)](http://www.apache.org/licenses/) -[![Maven Central](https://img.shields.io/maven-central/v/org.codehaus.plexus/plexus-i18n.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.codehaus.plexus/plexus-i18n) -[![Build Status](https://github.com/codehaus-plexus/plexus-i18n/actions/workflows/maven.yml/badge.svg)](https://github.com/codehaus-plexus/plexus-i18n/actions) +[![Maven Central](https://img.shields.io/maven-central/v/org.codehaus.plexus/plexus-i18n.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/org.codehaus.plexus/plexus-i18n) +[![GitHub CI](https://github.com/codehaus-plexus/plexus-i18n/actions/workflows/maven.yml/badge.svg)](https://github.com/codehaus-plexus/plexus-i18n/actions) +[![License](https://img.shields.io/github/license/codehaus-plexus/plexus-i18n.svg?label=License)](https://www.apache.org/licenses/LICENSE-2.0) -The canonical git repository is located at https://github.com/codehaus-plexus/plexus-i18n +Looks up localised messages from `ResourceBundle`s, with a default bundle and locale so callers don't have to pass them every time. Used by Maven reporting plugins to localise generated report text — `maven-project-info-reports-plugin`, `maven-surefire-report-plugin`, `maven-checkstyle-plugin`, `maven-pmd-plugin` and `maven-site-plugin` among them. + +It is a thin convenience layer over `java.util.ResourceBundle`, not a translation framework. + +## Status + +Maintained, but quiet by design — the API is small, stable and finished. Expect dependency updates and build maintenance rather than new features. + +Versions before `1.0.0` were published as `1.0-beta-*` for many years; `1.0.0` and `1.1.0` (November 2025) are the same component with the beta label dropped. If you are still on a `1.0-beta-*` version, moving to `1.1.0` should need no code changes. + +## Using it + +```xml + + org.codehaus.plexus + plexus-i18n + 1.1.0 + +``` + +Check the badge above for the current version. + +```java +@Inject +I18N i18n; + +String greeting = i18n.getString("report.title"); +String inFrench = i18n.getString("report.title", Locale.FRENCH); +String fromBundle = i18n.getString("my-bundle", Locale.FRENCH, "report.title"); +``` + +`I18N` is a JSR-330 singleton, so any [Eclipse Sisu](https://www.eclipse.org/sisu/) or Guice context can inject it. No Plexus container is involved — that was retired long ago, despite the name. + +## Requirements + +Java 8 or later. + +## Documentation + +- [Project site](https://codehaus-plexus.github.io/plexus-i18n/) +- [Javadoc](https://javadoc.io/doc/org.codehaus.plexus/plexus-i18n) +- [Release notes](https://github.com/codehaus-plexus/plexus-i18n/releases) + +## Contributing + +See [CONTRIBUTING.md](https://github.com/codehaus-plexus/.github/blob/master/CONTRIBUTING.md). In short: `mvn verify` builds, and run `mvn spotless:apply` before pushing or CI will fail on formatting. + +Please report security vulnerabilities privately — see [SECURITY.md](https://github.com/codehaus-plexus/.github/blob/master/SECURITY.md), not a public issue. From ff6a4db2ecea1e0b8f4f2006ca9e632cbfbae0ed Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 8 Aug 2026 18:53:55 +0200 Subject: [PATCH 2/2] Add a project description to the POM 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 --- pom.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pom.xml b/pom.xml index 90b954b..bdaec94 100644 --- a/pom.xml +++ b/pom.xml @@ -13,6 +13,8 @@ 1.1.1-SNAPSHOT Plexus I18N Component + Looks up localised messages from resource bundles, with a default bundle and + locale. scm:git:https://github.com/codehaus-plexus/plexus-i18n.git