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-xpx-chain-sdk Show documentation

The ProximaX Sirius Chain Java SDK is a Java library for interacting with the Sirius Blockchain.

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-xpx-chain-sdk/badge.svg?branch=master)](https://coveralls.io/github/proximax-storage/java-xpx-chain-sdk?branch=master)
[![Build Status](https://travis-ci.com/proximax-storage/java-xpx-chain-sdk.svg?branch=master)](https://travis-ci.com/proximax-storage/java-xpx-chain-sdk)

# ProximaX Sirius Blockchain Java SDK #

Official ProximaX Sirius Blockchain SDK Library in Java.

The ProximaX Sirius Chain Java SDK is a Java library for interacting with the Sirius Blockchain. It provides a complete library set coverage, and supports synchronous and asynchronous requests. This SDK can be used with JVM-based languages like Java, Kotlin, Scala.

## Use the library ##

See [wiki](https://github.com/proximax-storage/java-xpx-chain-sdk/wiki) for latest version of the project.

This library requires use of Java8. Releases of library are published to [Maven Central](https://search.maven.org/search?q=a:java-xpx-chain-sdk) and [snapshots](https://oss.sonatype.org/content/repositories/snapshots/io/proximax/java-xpx-chain-sdk/) are available in [Sonatype snapshot repository](https://oss.sonatype.org/content/repositories/snapshots/). To include library and its dependencies, add following to your build script:

### Maven ###

```xml

    io.proximax
    java-xpx-chain-sdk
    ${javaXpxVersion}

```

### Gradle ###

```gradle
compile "io.proximax:java-xpx-chain-sdk:${javaXpxVersion}"
```

## Documentation ##

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

Check [integration tests](https://github.com/proximax-storage/java-xpx-chain-sdk/tree/master/src/e2e/java/io/proximax/sdk) for working examples how to use the library.

## Contribution ##

We'd love to get more people involved in the project. Please feel free to [raise issue](https://github.com/proximax-storage/java-xpx-chain-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-xpx-chain-sdk/blob/master/LICENSE) file for details.

_{Copyright (c) 2019 ProximaX Limited}