From 4ed4f5394b647b4e0968ede5e222d9d688a95caf Mon Sep 17 00:00:00 2001 From: "Taro L. Saito" Date: Fri, 20 Jan 2017 00:31:59 -0800 Subject: [PATCH] Add javadoc badge --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b7fb9cd..9bcdab8 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -snappy-java [![Build Status](https://travis-ci.org/xerial/snappy-java.svg?branch=master)](https://travis-ci.org/xerial/snappy-java) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.xerial.snappy/snappy-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.xerial.snappy/snappy-java/) +snappy-java [![Build Status](https://travis-ci.org/xerial/snappy-java.svg?branch=master)](https://travis-ci.org/xerial/snappy-java) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.xerial.snappy/snappy-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.xerial.snappy/snappy-java/) [![Javadoc](https://javadoc-emblem.rhcloud.com/doc/org.xerial.snappy/snappy-java/badge.svg)](http://www.javadoc.io/doc/org.xerial.snappy/snappy-java) === snappy-java is a Java port of the snappy , a fast C++ compresser/decompresser developed by Google. @@ -41,7 +41,7 @@ Add the following dependency to your pom.xml: org.xerial.snappy snappy-java - 1.1.2.1 + 1.1.2.6 jar compile @@ -49,7 +49,7 @@ Add the following dependency to your pom.xml: ### Using with sbt ``` -libraryDependencies += "org.xerial.snappy" % "snappy-java" % "1.1.2.1" +libraryDependencies += "org.xerial.snappy" % "snappy-java" % "1.1.2.6" ``` @@ -77,7 +77,7 @@ In addition, high-level methods (`Snappy.compress(String)`, `Snappy.compress(flo ### Stream-based API Stream-based compressor/decompressor `SnappyOutputStream`/`SnappyInputStream` are also available for reading/writing large data sets. `SnappyFramedOutputStream`/`SnappyFramedInputStream` can be used for the [framing format](https://github.com/google/snappy/blob/master/framing_format.txt). - * See also [Javadoc API](https://oss.sonatype.org/service/local/repositories/releases/archive/org/xerial/snappy/snappy-java/1.1.2.1/snappy-java-1.1.2.1-javadoc.jar/!/index.html) + * See also [Javadoc API](https://oss.sonatype.org/service/local/repositories/releases/archive/org/xerial/snappy/snappy-java/1.1.2.6/snappy-java-1.1.2.6-javadoc.jar/!/index.html) #### Compatibility Notes * `SnappyOutputStream` and `SnappyInputStream` use `[magic header:16 bytes]([block size:int32][compressed data:byte array])*` format. You can read the result of `Snappy.compress` with `SnappyInputStream`, but you cannot read the compressed data generated by `SnappyOutputStream` with `Snappy.uncompress`. Here is the data format compatibility matrix: