updating readme

This commit is contained in:
Wolf Posdorfer 2017-12-01 11:02:53 +01:00
parent 19d3f573e1
commit 2db4a8ff49

View File

@ -9,44 +9,15 @@ A Java implementation of the Tendermint Application BlockChain Interface ([ABCI]
Check out [StartupExampleDummy.java](https://github.com/jTendermint/jabci/blob/master/src/main/java/com/github/jtendermint/jabci/StartupExampleDummy.java) or [JavaCounter.java](https://github.com/jTendermint/jabci/blob/master/src/main/java/com/github/jtendermint/jabci/JavaCounter.java) for examples.
#### Maven integration
jABCI v0.12.0 Release is now available via maven central. Use the following dependency to include the latest release:
jABCI v0.12.0.2 Release is now available via maven central. Use the following dependency to include the latest release:
```xml
<dependency>
<groupId>com.github.jtendermint</groupId>
<artifactId>jabci</artifactId>
<version>0.12.0</version>
<version>0.12.0.2</version>
</dependency>
```
Development will move onto a dedicated `develop` branch in the short term and it's artifacts will be available in Central's snapshot repository
The current snapshot repository is: `https://oss.sonatype.org/content/repositories/snapshots/` which can be used by adding the repository:
```xml
<repository>
<id>snapshots-repo</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases><enabled>false</enabled></releases>
<snapshots><enabled>true</enabled></snapshots>
</repository>
```
Use the following dependency to include current snapshot of jABCI in your project:
```xml
<dependency>
<groupId>com.github.jtendermint</groupId>
<artifactId>jabci</artifactId>
<version>0.12.0</version>
<scope>compile</scope>
<!-- you might want to exclude slf4j, depending on your setup -->
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
</exclusion>
</exclusions>
</dependency>
```
#### Update protobuf types
When you make changes to the protobuf file, you can enable the appropriate build-phase for the compiler-plugin to generate the file(s) in the target-directory.