Skip to content

Commit

Permalink
chore: Docs update for release 0.5.1 (#375)
Browse files Browse the repository at this point in the history
  • Loading branch information
satran004 authored Jan 31, 2024
1 parent 4a9b443 commit 5b9a962
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 25 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

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

### **Latest Stable Version**: [0.5.0](https://github.com/bloxbean/cardano-client-lib/releases/tag/v0.5.0)
### **Latest Stable Version**: [0.5.1](https://github.com/bloxbean/cardano-client-lib/releases/tag/v0.5.1)

### More details --> [Documentation](https://cardano-client.dev/)

Expand All @@ -21,6 +21,7 @@ A client library for Cardano in Java. This library simplifies the interaction wi
### **Tutorials**
- [Simple Ada transfer](https://cardano-client.dev/docs/gettingstarted/simple-transfer)
- [Multisig transfer using Native Script](https://cardano-client.dev/docs/gettingstarted/multisig-quickstart)
- [Governance Api](https://cardano-client.dev/docs/apis/governance-api)

### **Old Posts**

Expand Down Expand Up @@ -76,7 +77,10 @@ For fine-grained dependency management, add one or more below modules as require
| [cip20](cip/cip20) | cardano-client-cip20 | [CIP 20 - Transaction message/comment metadata](https://cips.cardano.org/cips/cip20/) <br> **Dependencies:** metadata |
| [cip25](cip/cip25) | cardano-client-cip25 | [CIP 25 - Media NFT Metadata Standard](https://cips.cardano.org/cips/cip25/) <br> **Dependencies:** metadata |
| [cip27](cip/cip27) | cardano-client-cip27 | [CIP 27 - CNFT Community Royalties Standard](https://cips.cardano.org/cips/cip27/) <br> **Dependencies:** cip25 |
| [cip30](cip/cip30) | cardano-client-cip30 | [CIP 30 - Cardano dApp-Wallet Web Bridge](https://cips.cardano.org/cips/cip30/) <br> **Dependencies:** cip8, core |
| [cip30](cip/cip30) | cardano-client-cip30 | [CIP 30 - Cardano dApp-Wallet Web Bridge](https://cips.cardano.org/cips/cip30/) <br> **Dependencies:** cip8, core <br/> |
| [cip68](cip/cip68) | cardano-client-cip68 | [CIP 68 - Datum Metadata Standard](https://cips.cardano.org/cips/cip68/) <br> **Dependencies:** cip67, cip25, plutus, transaction-spec |
| [ogmios-supplier](ogmios-supplier) | cardano-client-ogmios-supplier | Provides Ogmios specific implementation for ProtocolParamsSupplier and TransactionProcessor. |
| [kupo-supplier](kupo-supplier) | cardano-client-kupo-supplier | Provides Kupo specific implementation for UtxoSupplier. |

## Use as a library in a Java Project

Expand All @@ -90,7 +94,7 @@ For fine-grained dependency management, add one or more below modules as require
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-lib</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```
- Backend modules
Expand All @@ -101,49 +105,49 @@ For fine-grained dependency management, add one or more below modules as require
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-backend-blockfrost</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>

<!-- For Koios backend -->
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-backend-koios</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>

<!-- For Ogmios / Kupo backend -->
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-backend-ogmios</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```

**For Gradle, add the following dependencies to build.gradle**

- Core Module
```
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.1'
```
- Backend modules
- For backend support, use one of the following supported backend module

```groovy
//For Blockfrost
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.1'
//For Koios
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.1'
//For Ogmios / Kupo
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.1'
```


### For snapshot binaries

**SNAPSHOT_VERSION :** 0.5.1-SNAPSHOT (Please verify the latest snapshot version in gradle.properties)
**SNAPSHOT_VERSION :** 0.5.2-SNAPSHOT (Please verify the latest snapshot version in gradle.properties)

- For Maven, add the following dependencies and repository to project's pom.xml
```
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
18 changes: 9 additions & 9 deletions docs/docs/gettingstarted/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sidebar_position: 2
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-lib</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```
- **Backend modules**
Expand All @@ -27,21 +27,21 @@ sidebar_position: 2
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-backend-blockfrost</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>

<!-- For Koios backend -->
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-backend-koios</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>

<!-- For Ogmios backend -->
<dependency>
<groupId>com.bloxbean.cardano</groupId>
<artifactId>cardano-client-backend-ogmios</artifactId>
<version>0.5.0</version>
<version>0.5.1</version>
</dependency>
```

Expand All @@ -50,21 +50,21 @@ sidebar_position: 2
- **Core Module**

```
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.1'
```
- **Backend modules**

- For backend support, use one of the following supported backend module

```groovy
//For Blockfrost
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.1'
//For Koios
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.1'
//For Ogmios
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.0'
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.1'
```

Expand All @@ -73,7 +73,7 @@ implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.0'

:::info

**SNAPSHOT_VERSION :** 0.5.1-SNAPSHOT (Please verify the latest snapshot version in **gradle.properties**)
**SNAPSHOT_VERSION :** 0.5.2-SNAPSHOT (Please verify the latest snapshot version in **gradle.properties**)

:::

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 5 additions & 3 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A client library for Cardano in Java. This library simplifies the interaction wi

:::info

**Latest Stable Version**: [0.5.0](https://github.com/bloxbean/cardano-client-lib/releases/tag/v0.5.0)
**Latest Stable Version**: [0.5.1](https://github.com/bloxbean/cardano-client-lib/releases/tag/v0.5.1)

:::

Expand Down Expand Up @@ -52,6 +52,7 @@ A client library for Cardano in Java. This library simplifies the interaction wi
- Plutus smart contract call
- Token minting with Plutus contract
- Staking operations
- Governance transactions (Preview)

#### Composable Functions
- Composable functions to build transaction
Expand All @@ -74,6 +75,7 @@ A client library for Cardano in Java. This library simplifies the interaction wi
- [CIP8 - Message Signing](https://cips.cardano.org/cips/cip8/)
- [CIP30 - dApp signData & verify](https://cips.cardano.org/cips/cip30/)
- [CIP27 - CNFT Community Royalties Standard](https://cips.cardano.org/cips/cip27/)
- [CIP68 - Datum Metadata Standard](https://cips.cardano.org/cips/cip68/)

#### Metadata Builder
- Helper to build Metadata
Expand All @@ -93,10 +95,10 @@ Out of box, the library currently supports integration with following providers
- **Status :** Stable
- [Koios](https://www.koios.rest/)
- **Module :** cardano-client-backend-koios [README](https://github.com/bloxbean/cardano-client-lib/blob/master/backend-modules/koios/README.md)
- **Status :** Beta
- **Status :** Stable
- [Ogmios](https://ogmios.dev/)
- **Module :** cardano-client-backend-koios [README](https://github.com/bloxbean/cardano-client-lib/blob/master/backend-modules/ogmios/README.md)
- **Status :** Beta
- **Status :** Stable
- **Supported Apis :** submitTransaction, evaluateTx, Kupo support (UtxoService)

**Following Backend apis are currently available**
Expand Down
1 change: 0 additions & 1 deletion docs/src/components/HomepageExamples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,6 @@ export default function HomepageExamples() {
<div className="alert alert--success" role="alert">
Simple <strong>declarative</strong> api to build and submit transactions.
<br/>
Supported in <strong>v0.5.0-alpha.3 or later</strong>
</div>
<HomepageExample examples={quickTxExamples}/>
</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/components/HomepageFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const FeatureList = [
description: (
<>
Java Api for <br/>
CIP-8, CIP-20, CIP-25, CIP-30 ...
CIP-8, CIP-20, CIP-25, CIP-30, CIP-67/68 ...
</>
),
},
Expand Down

0 comments on commit 5b9a962

Please sign in to comment.