[sling-slingfeature-maven-plugin] branch master updated: Update documentation about feature archives

[cz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cziegeler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-slingfeature-maven-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 196aaf3  Update documentation about feature archives
196aaf3 is described below

commit 196aaf3bba1569d5e3dc146bc2473c723d7d6367
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Fri Mar 20 08:22:33 2020 +0100

    Update documentation about feature archives
---
 README.md | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 67a08e3..1efa11c 100644
--- a/README.md
+++ b/README.md
@@ -278,9 +278,35 @@ https://github.com/apache/sling-org-apache-sling-feature-analyser/blob/master/sr
 Attach feature files found in the project to the projects produced artifacts. This includes features
 found in `src/main/features` as well as features produce with the `aggregate-features` goal if no configuration is specified.
 
-## attach-featurearchives
-Attach a feature archive for each feature in the project to the projects produced artifacts. This includes features
-found in `src/main/features` as well as features produce with the `aggregate-features` goal if no configuration is specified.
+## Create Feature Archives (attach-featurearchives)
+
+A feature archive contains one or more features together with all artifacts referenced by the feature like bundles or other binary artifacts. With this goal such an archive can be created for features and attached to the project.
+
+By default all features known to the project are used to create a *single* feature archive, this includes features which are part of the source of the project, features generated by other plugins and aggregates.
+
+It is possible to refine which feature archives should be created by selecting features as well as creating multiple features. The below configuration creates two feature archives. The first one with the classifier *platformarchive* contains a single feature with the classifier *platform*. The second archive gets the classifier *uiarchive* and contains two features with the classifiers *uibase* and *ui*.
+
+```
+<execution>
+    <id>create-feature-archives</id>
+    <goals>
+        <goal>attach-featurearchives</goal>
+    </goals>
+    <configuration>
+        <archives>
+            <archive>
+                <classifier>platformarchive</classifier>
+                <includeClassifier>platform</includeClassifier>
+            </archive>
+            <archive>
+                <classifier>uiarchive</classifier>
+                <includeClassifier>uibase</includeClassifier>
+                <includeClassifier>ui</includeClassifier>
+            </archive>
+        </archives>        
+    </configuration>
+</execution>
+```
 
 ## Extract contents of an Extension (extract-extension)
 This goal can be used to extract the contents of an extension into a local file, which may be useful for other tools that can work on the content of the extension.
@@ -290,7 +316,9 @@ The goal is configured as in the following example:
 ```
 <execution>
     <id>extract-apiregions</id>
-    <goals><goal>extract-extension</goal></goals>
+    <goals>
+        <goal>extract-extension</goal>
+    </goals>
     <configuration>
         <selection>
             <featuresInclude>feature-abc.json</featuresInclude>