META-INF.README.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-chain-xipfs-sdk Show documentation

Official ProximaX P2P Storage SDK Library in Java.

The newest version!

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Coverage Status](https://coveralls.io/repos/github/proximax-storage/java-chain-xipfs-sdk/badge.svg?branch=master)](https://coveralls.io/github/proximax-storage/java-chain-xipfs-sdk?branch=master)
[![Build Status](https://travis-ci.com/proximax-storage/java-chain-xipfs-sdk.svg?branch=master)](https://travis-ci.com/proximax-storage/java-chain-xipfs-sdk)

# ProximaX P2P Storage Java SDK

Official ProximaX P2P Storage SDK Library in Java.

ProximaX is a project that utilizes the NEM blockchain technology with the IPFS P2P storage technology to form a very powerful proofing solution for documents or files which are stored in an immutable and irreversible manner, similar to the blockchain technology solutions.

## Use the library ##

See [wiki](https://github.com/proximax-storage/java-chain-xipfs-sdk/wiki) for current version of library.

This library requires use of Java8. Library is published to [Maven Central](https://search.maven.org/). To include library and its dependencies, add following to your build script:

### Maven ###

```xml

    io.proximax
    java-chain-xipfs-sdk
    ${javaXipfsVersion}

```

### Gradle ###

```gradle
compile "io.proximax:java-chain-xipfs-sdk:${javaXipfsVersion}"
```

### Groovy ###
```xml
@Grapes(
    @Grab(group='io.proximax', module='java-chain-xipfs-sdk', version=javaXipfsVersion)
)
```

## Documentation ##

For SDK documentation and examples see [wiki](https://github.com/proximax-storage/java-chain-xipfs-sdk/wiki) and [JavaDoc](https://proximax-storage.github.io/java-chain-xipfs-sdk/javadoc/).

## Contribution ##

We'd love to get more people involved in the project. Please feel free to [raise issue](https://github.com/proximax-storage/java-chain-xipfs-sdk/issues/new) or PR and we'll review your contribution.
    
## License ##

Project is licensed under Apache License Version 2.0. See [LICENSE](https://github.com/proximax-storage/java-chain-xipfs-sdk/blob/master/LICENSE) file for details.

_{Copyright (c) 2019 ProximaX Limited}