Skip to content

Commit

Permalink
Added snapshot release info
Browse files Browse the repository at this point in the history
  • Loading branch information
satran004 committed Mar 7, 2022
1 parent 228f41d commit 6dfbb60
Showing 1 changed file with 48 additions and 7 deletions.
55 changes: 48 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# cardano-client-lib
# cardano-client-lib

A client library for Cardano in Java. This library simplifies the interaction with Cardano blockchain from a Java application.

Expand All @@ -10,7 +10,7 @@ A client library for Cardano in Java. This library simplifies the interaction wi
bundles the platform specific binaries of this rust module. You can check the supported operating systems below.

## Supported Operating Systems (For 0.1.5 or earlier and 0.2.0-beta1)
The library has been tested on the following Operating Systems.
The library has been tested on the following Operating Systems.

- Apple MacOS (Intel and Apple Silicon)
- Linux (x86_64) (Ubuntu 18.04 and above or compatible ...)
Expand All @@ -21,6 +21,7 @@ The library has been tested on the following Operating Systems.
- [Cardano-client-lib : A Java Library to interact with Cardano - Part I](https://medium.com/p/83fba0fee537)
- [Cardano-client-lib: Transaction with Metadata in Java - Part II](https://medium.com/p/fa34f403b90e)
- [Cardano-client-lib: Minting a new Native Token in Java - Part III](https://medium.com/p/1a94a21cfeeb)
- [Composable functions to build transactions](https://medium.com/coinmonks/cardano-client-lib-new-composable-functions-to-build-transaction-in-java-part-i-be3a8b4da835)

**Examples**

Expand All @@ -36,7 +37,7 @@ The library has been tested on the following Operating Systems.
- Generate Address from Mnemonic phase

#### Transaction Serialization & Signing
- API to build Payment transaction (ADA & Native Tokens)
- API to build Payment transaction (ADA & Native Tokens)
- CBOR serialization of transaction
- Transaction signing

Expand All @@ -50,8 +51,8 @@ The library has been tested on the following Operating Systems.
- Policy Id generation

#### Backend Integration
The plugin also provides integration with Cardano node through different backend services.
Out of box, the library currently supports integration with [Blockfrost](https://blockfrost.io) through the Backend api.
The plugin also provides integration with Cardano node through different backend services.
Out of box, the library currently supports integration with [Blockfrost](https://blockfrost.io) through the Backend api.

For cardano-graphql backend, check [cardano-client-backend-gql](https://github.com/bloxbean/cardano-client-backend-gql) extension.

Expand All @@ -72,6 +73,8 @@ Other backend like Cardano-wallet will be added in future release.

### Add dependency

#### For release binary

- For Maven, add the following dependency to project's pom.xml
```
<dependency>
Expand All @@ -84,7 +87,45 @@ Other backend like Cardano-wallet will be added in future release.
- For Gradle, add the following dependency to build.gradle

```
compile 'com.bloxbean.cardano:cardano-client-lib:0.1.5'
implementation 'com.bloxbean.cardano:cardano-client-lib:0.2.0-beta2'
```

#### For snapshot binary

- For Maven, add the following dependency and repository to project's pom.xml
```
<dependencies>
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-lib</artifactId>
<version>0.2.0-beta3-SNAPSHOT</version>
</dependency>
</dependencies>
<repositories>
<repository>
<id>snapshots-repo</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
```
- For Gradle, add the following dependency and repository to build.gradle

```
repositories {
...
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
implementation 'com.bloxbean.cardano:cardano-client-lib:0.2.0-beta3-SNAPSHOT'
```

### Account API Usage
Expand Down Expand Up @@ -294,7 +335,7 @@ transactionHelperService.getUtxoTransactionBuilder().setUtxoSelectionStrategy(cu
```
git clone https://github.com/bloxbean/cardano-client-lib.git
./gradlew build fatJar
./gradlew clean build
```

# Run Integration Tests
Expand Down

0 comments on commit 6dfbb60

Please sign in to comment.