You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2019/05/08 16:16:09 UTC
[sling-whiteboard] 05/09: Updated README
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git
commit 64fbcfee0b6d464345f6fef91f300ddf68f86426
Author: Robert Munteanu <ro...@apache.org>
AuthorDate: Mon May 6 16:57:13 2019 +0200
Updated README
---
maven-sources-report-aggregator/README.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/maven-sources-report-aggregator/README.md b/maven-sources-report-aggregator/README.md
new file mode 100644
index 0000000..5744393
--- /dev/null
+++ b/maven-sources-report-aggregator/README.md
@@ -0,0 +1,17 @@
+# Apache Sling Maven Repository Source Availability Reporter
+
+This project offers a CLI interface to checking the availability of source artifacts on Maven Central.
+
+## Usage
+
+```
+$ mvn clean verify
+$ java -jar target/org.apache.sling.tooling.maven-sources-report-aggregator-*-jar-with-dependencies.jar org.apache*
+```
+
+The runnable jar takes a single argument, which is the groupId to match artifacts against. It is valid to add a trailing star,
+which signals a prefix match.
+
+The initial run may be slow, as the project downloads and imports the Maven Central index using the [Maven Indexer](https://maven.apache.org/maven-indexer/indexer-reader/index.html).
+
+After running, the report is placed in `out/results.csv`.
\ No newline at end of file