Modify MSB descriptioni, add instructions for installation and run.
authorHuabingZhao <zhao.huabing@zte.com.cn>
Tue, 20 Sep 2016 02:56:30 +0000 (10:56 +0800)
committerHuabingZhao <zhao.huabing@zte.com.cn>
Tue, 20 Sep 2016 03:00:21 +0000 (11:00 +0800)
Issue-id: OCS-54
Change-Id: I3e14ee69ba84ef13b1012159c8f1d4d0f420f832
Signed-off-by: HuabingZhao <zhao.huabing@zte.com.cn>
README.md

index af86b60..dc836cc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,21 @@
-Microservice Bus for OPEN-O
-
+##Microservice Bus
 Within the OPEN-O architecture, there are a lot of microservices, e.g., Catalog, Res Mgr., LCM Mgr., Drivers. These microservices are distributed on multiple hosts, that make the communicate between them complex because the consumers need to know the addresses of all the service providers. Besides, some services may have multiple instances, which make the consumer even harder to locate the service provider. Microservice bus provides a service registration/ discovery and routing mechanism to simply the communications between services. The consumers only need to talk with microservice bus without any address information of individual service providers. 
+##Runtime Requirements
+* Java 7
+
+##Run
+
+1. Install 1.7 or higer version of JDK
+1. export JAVA_HOME= "$JAVA_INSTALLATION_PATH" , please replace $JAVA_INSTALLATION_PATH with the JDK installation directory on your host
+1. Compile form source or download the latest snapshot from https://nexus.open-o.org/content/repositories/snapshots/org/openo/common-services/microservice-bus/msb-core-standalone/1.0.0-SNAPSHOT/
+1. tar -xzf msb-standalone-1.0.0-SNAPSHOT-linux64.tar.gz
+1. sudo -E ./startup.sh
+
+The default port is 80.
 
 ## License
 The Microservice Bus is released under version 2.0 of the [Apache License][].
 
-[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
+
\ No newline at end of file