svn commit: r1400597 - /maven/shared/trunk/maven-shared-utils/readme.md

[st...@apache.org]

Author: struberg
Date: Sun Oct 21 08:50:41 2012
New Revision: 1400597

URL: http://svn.apache.org/viewvc?rev=1400597&view=rev
Log:
MSHARED-236 add small readme

Added:
    maven/shared/trunk/maven-shared-utils/readme.md

Added: maven/shared/trunk/maven-shared-utils/readme.md
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/readme.md?rev=1400597&view=auto
==============================================================================
--- maven/shared/trunk/maven-shared-utils/readme.md (added)
+++ maven/shared/trunk/maven-shared-utils/readme.md Sun Oct 21 08:50:41 2012
@@ -0,0 +1,15 @@
+Apache Maven Shared Utils
+
+This project aims to be a functional replacement for
+plexus-utils in maven core. It is not a 100% API compatible
+replacement though. Lots of methods got cleaned up, generics
+got added and we dropped a lot of unused code.
+
+
+Relation to Commons-*
+
+maven-shared-utils internally use commons-io. We shade all commons
+classes into our own private package to prevent classpatch clashes.
+This is the reason why any public API in maven-shared-utils must
+avoid to expose commons classe directly. Most times it's sufficient
+to just create an empty subclass and expose that instead.