aboutsummaryrefslogtreecommitdiffstats
path: root/jtosca/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'jtosca/README.md')
-rw-r--r--jtosca/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/jtosca/README.md b/jtosca/README.md
new file mode 100644
index 0000000..a3a150f
--- /dev/null
+++ b/jtosca/README.md
@@ -0,0 +1,41 @@
+# ONAP JTOSCA
+
+
+---
+---
+
+# Introduction
+
+ONAP JTOSCA is delivered as helper JAR that can be used by clients that work with TOSCA CSAR files.
+It parses the CSAR and returns the model object which represents the CSAR contents.
+Prior to that, it performs validations on the CSAR to check its TOSCA compliance.
+
+
+# Compiling ONAP JTOSCA
+
+ONAP JTOSCA can be compiled easily using maven command: `mvn clean install`
+The result is JAR file under "target" folder
+
+# Getting Help
+
+*** to be completed on release ***
+
+SDC@lists.onap.org
+
+SDC Javadoc and Maven site
+
+*** to be completed on rrelease ***
+
+# Release notes for versions
+
+1.1.0-SNAPSHOT
+
+Initial after separating into separate repo
+
+-------------------------------
+
+1.1.1-SNAPSHOT
+
+Added toString of Function (GetInput, etc.)
+
+Allowed two arguments for GetInput - name of list input and index in list