diff --git a/README.md b/README.md index 3eff823..01d70af 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ # Overview -JTar is a simple Java Tar library, that provides an easy way to create and read tar files using IO streams. The API is very simple to use and similar to the _java.util.zip_ package and also __supports UStar format__. +JTar is a simple Java Tar library, that provides an easy way to create and read tar files using IO streams. The API is very simple to use and similar to the *java.util.zip* package. This repo is forked from [kamranzafar/jtar](https://github.com/kamranzafar/jtar) with modifications to build on Android and switch to use **GNU USTAR tar header**. -[![Build Status](https://travis-ci.org/kamranzafar/jtar.png?branch=master)](https://travis-ci.org/kamranzafar/jtar) +[![](https://jitpack.io/v/topjohnwu/jtar.svg)](https://jitpack.io/#topjohnwu/jtar) ## Usage -JTar is available in maven central and can be added as a dependency in the maven project. -
  <dependency>
-    <groupId>org.kamranzafar</groupId>
-    <artifactId>jtar</artifactId>
-    <version>2.3</version>
-  </dependency>
-
+JTar is available on Jitpack and can be added as a dependency. +``` +repositories { + ... + maven { url 'https://jitpack.io' } +} +dependencies { + implementation 'com.github.topjohnwu:jtar:1.0.0' +} +``` Below are some examples of using jtar in applications @@ -69,10 +72,3 @@ Below are some examples of using jtar in applications ___Tip: Always use buffered streams with jtar to speed up IO.___ - -## Examples and resources - -* See [JTarTest](https://github.com/kamranzafar/jtar/blob/master/src/test/java/org/kamranzafar/jtar/JTarTest.java) class, provided with the source, for more detailed examples. -* Visit the wiki page for more details on [Tar format](http://en.wikipedia.org/wiki/Tar_%28file_format%29) - -__JTar is available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kamranzafar%22%20a%3A%22jtar%22)__