grpcServer unit test cases added

[cli.git] / README.md

diff --git a/README.md b/README.md
index a400bb0..b1003e9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,21 +1,40 @@
-OPEN Command-line interface (CLI)
-==================================
+[comment]: # (# Copyright 2018 Huawei Technologies Co., Ltd.)
+[comment]: # (# )
+[comment]: # (Licensed under the Apache License, Version 2.0 (the "License")
+[comment]: # (# you may not use this file except in compliance with the License.)
+[comment]: # (# You may obtain a copy of the License at)
+[comment]: # (#)
+[comment]: # (#     http://www.apache.org/licenses/LICENSE-2.0)
+[comment]: # (#)
+[comment]: # (# Unless required by applicable law or agreed to in writing, software)
+[comment]: # (# distributed under the License is distributed on an "AS IS" BASIS,)
+[comment]: # (# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.)
+[comment]: # (# See the License for the specific language governing permissions and)
+[comment]: # (# limitations under the License.)
+
+Open Command-line interface Platform (OCLIP)
+============================================
 
 Provides unified commands to operate any cloud enabled software
-products from Linux/Web console. Configure the following environment
-variables, before using it:
+products from Linux/Web console.
+
+Set the following environment variable, before using OCLIP:
+
+**OPEN_CLI_HOME** - Complete path of directory, where OCLIP is installed.
+
+To Run a command
+-----------------
+Configure the following environment variables:
 
 1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL
 2. **OPEN_CLI_HOST_USERNAME** - Service user name
 3. **OPEN_CLI_HOST_PASSWORD** - Service password
 
-To Run a command
------------------
-Type **oclip <command>** from linux console.
+Run **oclip <command>** from Linux console.
 
 To Run in Interactive mode
 --------------------------
-Type **oclip** from linux console.
+Run **oclip** from Linux console.
 
 And use the directive set to set the values for following parameters:
 
@@ -23,20 +42,22 @@ And use the directive set to set the values for following parameters:
 2. **host-username** - Service user name
 3. **host-password** - Service password
 
-Set the product version
-------------------------
+NOTE: This mode is available as Web command console when OCLIP is running from docker.
+
+Select the product version
+--------------------------
 CLI framework is enhanced to handle multiple product versions at same
-time. so to choose the product version, set evironment variable
+time. so to choose the product version, set environment variable
 **OPEN_CLI_PROUDCT_IN_USE**.
 
 NOTE: In interactive mode, product version can be selected using
 typing **use <product-version>**
 
-Run *oclip [-v|--version]* to see the CLI and available product version details
+Run *oclip [-v|--version]* to see the available product version details.
 
 Set the parameter values
 ------------------------
-Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.
+Use the directive 'set' for setting the values for parameters and 'unset' for un-setting the values.
 
 Help
 ----
@@ -49,10 +70,3 @@ To run in debug mode, set following environment variables:
 
 1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true
 2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
-
-<h2><a id="More_details_42"></a>More details</h2>
-<p><a href="https://wiki.onap.org">https://wiki.onap.org</a></p>
-
-<h2><a id="Download_42"></a>To download</h2>
-<p style="color:red">Please download Open CLI Platform <a href="./open-cli.zip">here</a></p>
-