topjohnwu/jtar
1
0
Fork 0
mirror of https://github.com/topjohnwu/jtar.git synced 2024-11-23 03:19:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
John Wu 2019-04-02 01:36:28 -04:00 committed by GitHub
parent fa6a9b04b8
commit ddd6be5f19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -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.
<pre><code> &lt;dependency&gt;
&lt;groupId&gt;org.kamranzafar&lt;/groupId&gt;
&lt;artifactId&gt;jtar&lt;/artifactId&gt;
&lt;version&gt;2.3&lt;/version&gt;
&lt;/dependency&gt;
</code></pre>
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
</code></pre>
___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)__