monasca-common/README.md
Deklan Dieterly 72028b95b2 Update README.md
Add build instructions.
2014-06-11 14:13:22 -06:00

33 lines
1.7 KiB
Markdown

# Overview
`mon-common` is a collection of sub-projects containing reusable application and platform code for building monitoring related services.
### Build Instructions
Download and do mvn install from within the java directory.
```
cd java
mvn clean install
```
### Application Specific Sub-Projects
* [mon-model](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-model) - Common domain and event models for monitoring services.
### Platform Sub-Projects
* [mon-dropwizard](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-dropwizard) - Utilities for building and testing dropwizard services.
* [mon-kafka](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-kafka) - Various utilities for working with Kafka.
* [mon-persistence](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-persistence) - Persistence related infrastructure and utilities.
* [mon-service](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-service) - Simple service abstractions and utilities.
* [mon-streaming](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-streaming) - Streaming related utilities.
* [mon-testing](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-testing) - A set of testing related dependencies.
* [mon-util](https://git.hpcloud.net/mon/mon-common/tree/master/java/mon-util) - Various utilities such as for serialization, dependency injection, date and time, invocation retries, concurrency, etc.
### Deploying to Nexus
To deploy to nexus, just run the command below, inserting a version number that is greater than the current nexus version (this command is usually performed by Jenkins):
```
mvn deploy -DBUILD_NUM=${BUILD_NUMBER}
```