Skip to content

Commit

Permalink
extend README.md with info about actual build statua and minor additi…
Browse files Browse the repository at this point in the history
…onal info added for end-users
  • Loading branch information
tkohegyi committed Aug 25, 2015
1 parent ea2f012 commit 6a993fb
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,26 @@ Also can be used for manual tests. It is expandable easily via plugins.
#Quick intro for end users
##Wilma application
####Requirements
* JRE 7
* JRE 7 or 8
* The latest [release](https://github.com/epam/Wilma/releases) of Wilma application downloaded and extracted into a folder.

####Running
`java -jar wilma-x.y.z.jar wilma.conf.properties`

####Configuring Components/Services to use Wilma
The most simple way to do this is by configuring the Component/Service to use Wilma as HTTP(S) proxy.
In case of Java components/services, this can be done by adding a few VM arguments to the run configuration:

```
-DproxyHost=[wilma-url]
-DproxyPort=[wilma-port]
```

See [this page](http://epam.github.io/Wilma/endusers/index.html) for more detailed information on how to configure Wilma, and Component/Service that uses Wilma.

##Wilma Message Search application
####Requirements
* JDK 7
* JDK 7 or 8
* The latest [release](https://github.com/epam/Wilma/releases) of Wilma Message Search application downloaded and extracted into a folder.

####Running
Expand All @@ -40,7 +51,7 @@ Also can be used for manual tests. It is expandable easily via plugins.
#Quick intro for developers/contributors

####Requirements
* Java JDK 7 or 8
* Java JDK 8

####Advised working environment
* IntelliJ / Eclipse
Expand All @@ -49,6 +60,7 @@ Also can be used for manual tests. It is expandable easily via plugins.
####Building with Gradle
The project can be built by following the instructions described [here](https://github.com/epam/Wilma/wiki/DEV,-Build-from-Scratch).
This way of build is recommended for contributors only, End-Users, please use the pre-built downloadable releases from [here](https://github.com/epam/Wilma/releases).
Actual build status: [![Build Status](https://travis-ci.org/epam/Wilma.svg?branch=master)](https://travis-ci.org/epam/Wilma)

##Detailed information
* Check the [Wiki](https://github.com/epam/Wilma/wiki) and [Issues](https://github.com/epam/Wilma/issues) link on GitHub
Expand Down

0 comments on commit 6a993fb

Please sign in to comment.