Merge "Copyright Check Script"

[cps.git] / README.md

diff --git a/README.md b/README.md
index d5f0c66..61a3af4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,33 +1,29 @@
-# Configuration Persistence Service
-
-This folder contains all files for
-[Configuration Persistence Service](https://wiki.onap.org/pages/viewpage.action?pageId=81406119).
-
-The code here is related to CPS POC, then it must be kept self contained in this cps folder to prevent any impact on
-current ccsdk components and to be ready to be moved in its own repo once CPS becomes a standalone project.
-
-
-## Running Locally
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2021 Nordix Foundation.
+  ================================================================================
+  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.
+
+  SPDX-License-Identifier: Apache-2.0
+  ============LICENSE_END=========================================================
+-->
 
-* Run a postgres container instance and create `cpsdb' database:
-
-```
-CREATE USER cps WITH PASSWORD 'cps';
-CREATE DATABASE cpsdb OWNER cps;
-```
-
-* Build (from cps root folder)
-
-```bash
-mvn clean package
-```
+# Configuration Persistence Service
 
-* Run (from cps root folder)
+## General Information
+* [CPS Project Wiki](https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project)
 
-```bash
-java -DDB_HOST=localhost -DDB_USERNAME=cps -DDB_PASSWORD=cps -jar cps-rest/target/cps-rest-0.0.1-SNAPSHOT.jar
-```
+## For Developers
+* [Developer Wiki](https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Developer%27s+Landing+Page)
+* [Building and running CPS locally](docker-compose/README.md)
 
-* Browse
-  * [Swagger UI](http://localhost:8080/api/cps/swagger-ui/index.html)
-  * [Api Documentation](http://localhost:8080/api/cps/v3/api-docs)