summaryrefslogtreecommitdiffstats
path: root/winery/org.eclipse.winery.highlevelrestapi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'winery/org.eclipse.winery.highlevelrestapi/README.md')
-rw-r--r--winery/org.eclipse.winery.highlevelrestapi/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/winery/org.eclipse.winery.highlevelrestapi/README.md b/winery/org.eclipse.winery.highlevelrestapi/README.md
new file mode 100644
index 0000000..fa1820b
--- /dev/null
+++ b/winery/org.eclipse.winery.highlevelrestapi/README.md
@@ -0,0 +1,8 @@
+This project provides a wrapper around org.apache.commons.httpclient.
+
+It is independent of Winery itself as Winery uses JAX-RS.
+The generated implementation artifacts, however, rely on this package.
+
+## Build fat JARs
+To build a fatJar of the HighLevelRestAPI which also contains all the dependencies use the maven profile fatJar (i.e., run `mvn clean package -P fatJar`).
+Maven will create a JAR called `org.eclipse.winery.highlevelrestapi-*-jar-with-dependencies.jar` in `/target`. \ No newline at end of file