[PORTAL-16 PORTAL-18] Widget ms; staging

[portal.git] / ecomp-portal-BE-common / README.md

diff --git a/ecomp-portal-BE-common/README.md b/ecomp-portal-BE-common/README.md
new file mode 100644 (file)
index 0000000..70d4ef2
--- /dev/null
+++ b/ecomp-portal-BE-common/README.md
@@ -0,0 +1,10 @@
+# ECOMP Portal Web Application Back End Common Files
+
+## Overview
+
+This is a Maven overlay project with the ECOMP Portal back-end common files. 
+This is not a stand-alone web application.  This project has common Java classes
+that are used in the internal and ONAP versions of the ECOMP Portal web application. 
+Those specific versions are built using separate Maven projects that copy in
+("overlay") the contents of this project at package time and that use the jar
+built by this project.
\ No newline at end of file