[sling-org-apache-sling-feature-analyser] branch master updated: Add initial readme.md file.

[da...@apache.org]

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-org-apache-sling-feature-analyser.git


The following commit(s) were added to refs/heads/master by this push:
     new 01d4d29  Add initial readme.md file.
01d4d29 is described below

commit 01d4d295ecaab9269a5f60f4fb367f23b2b35884
Author: David Bosschaert <bo...@adobe.com>
AuthorDate: Wed May 2 12:28:04 2018 +0100

    Add initial readme.md file.
---
 pom.xml   | 1 +
 readme.md | 9 +++++++++
 2 files changed, 10 insertions(+)

diff --git a/pom.xml b/pom.xml
index 05185e4..91def0c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -77,6 +77,7 @@
                 <artifactId>apache-rat-plugin</artifactId>
                 <configuration>
                     <excludes>
+                        <exclude>readme.md</exclude>
                         <exclude>src/main/resources/META-INF/services/org.apache.sling.feature.analyser.task.AnalyserTask</exclude>
                         <exclude>src/main/resources/META-INF/services/org.apache.sling.feature.scanner.spi.ExtensionScanner</exclude>
                         <exclude>src/main/resources/META-INF/services/org.apache.sling.feature.scanner.spi.FrameworkScanner</exclude>
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..99b4eb1
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,9 @@
+# OSGi Feature Model Analyser
+
+The Analyser can analyse a feature for completeness, to ensure all requirements are satisfied by capabilities. The analyser is pluggable and can also perform other checks.
+
+The analyser can be run from the commandline by running the following main class:
+
+```
+java org.apache.sling.feature.analyser.main.Main
+```
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
davidb@apache.org.