Add DCM to Helm deployment folder

[multicloud/k8s.git] / README.md

diff --git a/README.md b/README.md
index c3de0b5..8aeed38 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,25 +16,25 @@ MultiCloud Kubernetes plugin for ONAP multicloud.
 # Installation
 
 Requirements:
-* Go 1.11
+* Go 1.14.4
 
 Steps:
 
-* Clone repo in GOPATH src:
-    * `cd $GOPATH/src && git clone https://git.onap.org/multicloud/k8s`
+* Clone repo:
+    * `git clone https://git.onap.org/multicloud/k8s`
 
-* Run unit tests:
-    *  `make build`
+* Build everything:
+    *  `cd k8s/src/k8splugin && make all`
 
-* Compile to build Binary:
-    * `make deploy`
+* Run Tests:
+    *  `cd k8s/src/k8splugin && make test`
 
-# Architecture
+* Generate Coverage Report:
+    * `cd k8s/src/k8splugin && make cover`
 
-Create Virtual Network Function
+* Run the plugin:
+    * `cd k8s/deployments && ./start.sh`
 
-![Create VNF](./docs/create_vnf.png)
+# Troubleshooting
 
-Create Virtual Link
-
-![Create VL](./docs/create_vl.png)
+* Logs can be set as "warn" or "info" in the config.json file of the orchestrator directory. By default the log level is set as "warn".