This is an automated email from the ASF dual-hosted git repository.
davidb 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 3079f20 Add some documentation in the README.md
3079f20 is described below
commit 3079f201f2cc293df873bddcb86a2857f78ddf87
Author: David Bosschaert <[email protected]>
AuthorDate: Wed Aug 29 11:41:33 2018 +0100
Add some documentation in the README.md
---
README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 54 insertions(+)
diff --git a/README.md b/README.md
index aa95ae8..b5247fd 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,57 @@
This module is part of the [Apache Sling](https://sling.apache.org) project.
Maven Plugin for OSGi Applications
+
+## Supported goals
+
+### generate-resources
+This goal processed feature files to substitute Maven variable placeholders in
feature files such as `${project.groupId}`, `${project.artifactId}` and
`${project.version}`
+
+### attach-feature
+Attach feature files to the projects produced artifacts
+
+### assemble-feature
+Produce an assembled feature from a list of features.
+
+Sample configuration:
+
+```
+ <plugin>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>slingfeature-maven-plugin</artifactId>
+ <version>0.2.0-SNAPSHOT</version>
+ <executions>
+ <execution>
+ <id>merge-features</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>aggregate-features</goal>
+ </goals>
+ <configuration>
+ <classifier>my-aggregated-feature</classifier>
+ <features>
+ <directory>
+ <location>${basedir}/src/main/my-features</location>
+ <includes>*.json</includes>
+ <excludes>exclude-me.json</excludes>
+ <excludes>exclude-me-too.json</excludes>
+ </directory>
+ <artifact>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.myfeatures</artifactId>
+ <version>1.2.3</version>
+ <type>slingfeature</type>
+ <classifier>someclassifier</classifier>
+ </artifact>
+ </features>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+```
+
+All features found in both the directories as well as the artifact sections of
the configuration are aggregated into a single feature.
+
+The generated feature will have the same `groupId`, `artifactId` and `version`
as the pom in which
+the aggregation is configured. It will have type `slingfeature` and as
classifier the one specified
+in the configuration.
\ No newline at end of file
