From f8d5f0fc0efd133711badc9a9c97624ba0b485b0 Mon Sep 17 00:00:00 2001 From: Asitha Nanayakkara Date: Wed, 18 Jan 2017 09:19:19 +0530 Subject: [PATCH] Update readme.md --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9733a36..4e238df 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,13 @@ Overview ----------- Performance testing client for WSO2 Message Broker. -Goal of this project is to write a comprehensive test client for [WSO2 Message Broker (MB)](http://wso2.com/products/message-broker/). This is a java based console application with the capability to run test scenarios according to a configuration file given at startup. +Goal of this project is to write a comprehensive test client for +[WSO2 Message Broker (MB)](http://wso2.com/products/message-broker/). +This is a java based console application with the capability to run test scenarios according to a configuration file +given at startup. -Currently this client supports testing AMQP protocol based functionality of MB. Client is written using [JMS](https://docs.oracle.com/javaee/6/tutorial/doc/bncdr.html) +Currently this client supports testing AMQP protocol based functionality of MB. Client is written using +[JMS](https://docs.oracle.com/javaee/6/tutorial/doc/bncdr.html) #### Supported functionality @@ -33,23 +37,27 @@ Currently this client supports testing AMQP protocol based functionality of MB. Build ------ -To get started clone this project and build using maven +To get started clone this project and build using maven (or else get the binaries from the +[releases](https://github.com/Asitha/andes-test-client/releases).) + ``` mvn clean install ``` Run ---- -Extract andes-test-client-\-pack.zip in `target/` directory. Inside the extracted file execute the **client.sh** file to run the client. This will use the default configuration file (\/conf/client.yaml) to run the test. +Extract andes-test-client-\-pack.zip in `target/` directory. Inside the extracted file execute the +**andes-test-client_\** executable to run the client. This will use the default configuration file +(\/conf/client.yaml) to run the test. ``` -sh client.sh +$ ./andes-test-client_1.0-SNAPSHOT ``` If you want to run a different test configuration point to that file using option `--conf` or `-c` ``` -sh client.sh --conf +$ ./andes-test-client_1.0-SNAPSHOT --conf -sh client.sh -c +$ ./andes-test-client_1.0-SNAPSHOT -c ``` Configure Test Cases