Add docs.

[scp/ric-app/kpimon.git] / README.md

diff --git a/README.md b/README.md
index 45b02ce..e792a4e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,26 @@
-# kpimon
-KPIMON xApp for Bronze Release
 
-# Image Build
+==================================================================================
+       Copyright (c) 2020 AT&T Intellectual Property.
 
-```
-$ docker build . --tag kpimon:{TAG} --no-cache
-```
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================================
+
+KPI Monitoring
+================
+
+This repository contains the source for the RIC KPI monitoring application.
+
+This xApp can be onboarded through the xApp Onboarder.  The xapp descriptor 
+is under the xapp-descriptor/ directory.
+
+Then the xapp can be deployed through the App Manager.