Skip to content

Commit

Permalink
Coverage badge and readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bmarwell committed May 19, 2019
1 parent fca2683 commit 833c5b1
Showing 1 changed file with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,39 @@
# zchunk-java

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Build Status](https://travis-ci.org/bmhm/zchunk-java.svg?branch=master)](https://travis-ci.org/bmhm/zchunk-java)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0
) [![Build Status](https://travis-ci.org/bmhm/zchunk-java.svg?branch=master)](https://travis-ci.org/bmhm/zchunk-java
) [![codecov](https://codecov.io/gh/bmhm/zchunk-java/branch/master/graph/badge.svg)](https://codecov.io/gh/bmhm/zchunk-java
)

zchunk is a compressed file format that splits the file into independent chunks.

This is a **pure java-only implementation** of the [ZChunk](https://github.com/zchunk/zchunk) file format.
It does not hard depend on other libraries and can be used without any external or transitive dependencies.

## What is zchunk?

**zchunk** is a compressed file format that splits the file into independent chunks.
This allows you to only download changed chunks when downloading a new version
of the file, and also makes zchunk files efficient over rsync.

zchunk files are protected with strong checksums to verify that the file you
downloaded is, in fact, the file you wanted.

**As of zchunk-1.0, the ABI and API have been marked stable, and the only changes
allowed are backwards-compatible additions**
## What is the goal of this project?



## What dependencies do I need?

**zchunk-java** can be used *without any* transitives dependencies/libraries.

## Requirements
However, to have support for compression, you should use the arteifact `zchunk-all` (TBD), which also
pulls in support for `zstd` compression and maybe other compressions later.

* Java 8 or newer
* Maven

## Installation
## Runtime Requirements and usage

* `mvn clean install`
* Java 8 or newer, any JDK (adopt and adopt-openj9 work well).

## Usage

### To read a file header:

Expand Down Expand Up @@ -69,5 +81,17 @@ class Main {
### executable jars

=> TBD

## Building from source

### Build requirements

* Maven 3.3.1 or newer, or just use `mvnw`.

### Installation

* `./mvnw clean install`




0 comments on commit 833c5b1

Please # to comment.