Skip to content

Commit dfae335

Browse files
authored
Add release info to readme
1 parent 7c15a27 commit dfae335

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
[![Build Status](https://travis-ci.org/ehrmann/vcdiff-java.svg?branch=master)](https://travis-ci.org/ehrmann/vcdiff-java)
22
[![Coverage Status](https://coveralls.io/repos/github/ehrmann/vcdiff-java/badge.svg?branch=master)](https://coveralls.io/github/ehrmann/vcdiff-java?branch=master)
3+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.davidehrmann.vcdiff/vcdiff-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.davidehrmann.vcdiff/vcdiff-parent)
34

45
# VCDiff-java
56

67
A Java port of Google's [open-vcdiff](https://github.com/google/open-vcdiff) vcdiff (RFC3284) implementation.
78
It's currently synced with [open-vcdiff 0.8.4](https://github.com/google/open-vcdiff/releases/tag/openvcdiff-0.8.4).
89

10+
## Download
11+
Maven:
12+
```xml
13+
<dependency>
14+
<groupId>com.davidehrmann.vcdiff</groupId>
15+
<artifactId>vcdiff-core</artifactId>
16+
<version>0.1.0</version>
17+
</dependency>
18+
```
19+
20+
Gradle:
21+
```
22+
compile 'com.davidehrmann.vcdiff:vcdiff-core:0.1.0'
23+
```
24+
925
## Usage
1026
### Encoding (compressing)
1127
```java
@@ -48,6 +64,22 @@ java com.davidehrmann.vcdiff.VCDiffFileBasedCoder decode -dictionary dict -delta
4864
java com.davidehrmann.vcdiff.VCDiffFileBasedCoder help
4965
```
5066

67+
The command line tool is available in the Central Repository
68+
69+
Maven:
70+
```xml
71+
<dependency>
72+
<groupId>com.davidehrmann.vcdiff</groupId>
73+
<artifactId>vcdiff-cli</artifactId>
74+
<version>0.1.0</version>
75+
</dependency>
76+
```
77+
78+
Gradle:
79+
```
80+
compile 'com.davidehrmann.vcdiff:vcdiff-cli:0.1.0'
81+
```
82+
5183
## See also
5284
* [Femtozip](https://github.com/gtoubassi/femtozip) (includes dictionary generator)
5385
* [Diffable](https://web.archive.org/web/20120301201412/http://code.google.com/p/diffable/)

0 commit comments

Comments
 (0)