svn commit: r768489 - /tuscany/maven-plugins/trunk/maven-zip-plugin/README

[an...@apache.org]

Author: antelder
Date: Sat Apr 25 07:23:00 2009
New Revision: 768489

URL: http://svn.apache.org/viewvc?rev=768489&view=rev
Log:
Update readme with a little more on what the plugin does

Modified:
    tuscany/maven-plugins/trunk/maven-zip-plugin/README

Modified: tuscany/maven-plugins/trunk/maven-zip-plugin/README
URL: http://svn.apache.org/viewvc/tuscany/maven-plugins/trunk/maven-zip-plugin/README?rev=768489&r1=768488&r2=768489&view=diff
==============================================================================
--- tuscany/maven-plugins/trunk/maven-zip-plugin/README (original)
+++ tuscany/maven-plugins/trunk/maven-zip-plugin/README Sat Apr 25 07:23:00 2009
@@ -1,6 +1,19 @@
 This module is a Maven plugin which supports using a packaging of zip in a pom.xml to 
 create a zip format SCA contribution.
 
+The main difference between an SCA zip and jar contribution is that a zip contribution supports
+nesting jar's within the zip and having those nested jar's available within the classloader
+of the contribution. This enables packaging application classes and any 3rd party jars they
+depend on together in one contribution.
+
+The zip plugin builds a zip archive of the project and includes any dependency jars used by 
+the project inside the zip in a folder name "lib" 
+     
+TODOs: 
+- make the "lib/" folder where the dependent jars go configurable
+- make which dependencies get included configurable 
+  (currently its those with compile or runtime scope)
+
 An example pom.xml:
    <packaging>zip</packaging>
    ... 
@@ -16,10 +29,17 @@
       </plugins>
    </build>
 
+
+-----------------------------------------------------------------------------
 This Tuscany module includes much code copied from the Maven WAR plugin 2.0.2 
 written by the Apache Maven team.
+-----------------------------------------------------------------------------
+
 
-To build, from the top maven-zip-plugin directory run maven:
+Building and releasing the plugin
+---------------------------------
+
+From the top maven-zip-plugin directory run maven:
 
 mvn
 
@@ -76,6 +96,3 @@
 
 cp -p -v -R  maven-zip-plugin-alpha1/org/apache/tuscany/maven/plugins/ /x1/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/tuscany/maven/plugins
 
-
-
-