diff --git a/README.md b/README.md index a956a58a..f8c78740 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,6 @@ For publishing [the site](https://codehaus-plexus.github.io/plexus-utils/) do th mvn -Preporting verify site site:stage scm-publish:publish-scm ``` -Starting with version 4, XML classes (in `org.codehaus.plexus.util.xml` and `org.codehaus.plexus.util.xml.pull`) have been extracted to a separate [`plexus-xml`](https://github.com/codehaus-plexus/plexus-xml/) 4: if you need them, just use this new artifact. +Starting with version 4, XML classes (in `org.codehaus.plexus.util.xml` and `org.codehaus.plexus.util.xml.pull`) have been extracted to a separate [`plexus-xml`](https://github.com/codehaus-plexus/plexus-xml/) library: if you need them, just use this new artifact. + +`plexus-utils` 4 keeps an optional dependency on `plexus-xml` to keep compatibility with the few XML-oriented methods of `ReaderFactory` and `WriterFactory`: these classes are deprecated, you should migrate as explained in javadoc. diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md new file mode 100644 index 00000000..5b8f4a0e --- /dev/null +++ b/src/site/markdown/index.md @@ -0,0 +1,7 @@ +## Plexus Common Utilities + +A collection of various utility classes to ease working with strings, files, command lines and more. + +Starting with version 4, XML classes (in `org.codehaus.plexus.util.xml` and `org.codehaus.plexus.util.xml.pull`) have been extracted to a separate [`plexus-xml`](../plexus-xml/) library: if you need them, just use this new artifact. + +`plexus-utils` 4 keeps an optional dependency on `plexus-xml` to keep compatibility with the few XML-oriented methods of [`ReaderFactory`](./apidocs/org/codehaus/plexus/util/ReaderFactory.html) and [`WriterFactory`](./apidocs/org/codehaus/plexus/util/WriterFactory.html): these classes are deprecated, you should migrate as explained in javadoc. diff --git a/src/site/site.xml b/src/site/site.xml index 5de0c6cb..0d5a3d79 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -4,6 +4,9 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"> + + +