Skip to content

Commit 5b9a962

Browse files
satran004satran004
authored
chore: Docs update for release 0.5.1 (#375)
1 parent 4a9b443 commit 5b9a962

File tree

11 files changed

+30
-25
lines changed

11 files changed

+30
-25
lines changed

‎README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

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

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

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

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

2526
### **Old Posts**
2627

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

8185
## Use as a library in a Java Project
8286

@@ -90,7 +94,7 @@ For fine-grained dependency management, add one or more below modules as require
9094
<dependency>
9195
<groupId>com.bloxbean.cardano</groupId>
9296
<artifactId>cardano-client-lib</artifactId>
93-
<version>0.5.0</version>
97+
<version>0.5.1</version>
9498
</dependency>
9599
```
96100
- Backend modules
@@ -101,49 +105,49 @@ For fine-grained dependency management, add one or more below modules as require
101105
<dependency>
102106
<groupId>com.bloxbean.cardano</groupId>
103107
<artifactId>cardano-client-backend-blockfrost</artifactId>
104-
<version>0.5.0</version>
108+
<version>0.5.1</version>
105109
</dependency>
106110

107111
<!-- For Koios backend -->
108112
<dependency>
109113
<groupId>com.bloxbean.cardano</groupId>
110114
<artifactId>cardano-client-backend-koios</artifactId>
111-
<version>0.5.0</version>
115+
<version>0.5.1</version>
112116
</dependency>
113117

114118
<!-- For Ogmios / Kupo backend -->
115119
<dependency>
116120
<groupId>com.bloxbean.cardano</groupId>
117121
<artifactId>cardano-client-backend-ogmios</artifactId>
118-
<version>0.5.0</version>
122+
<version>0.5.1</version>
119123
</dependency>
120124
```
121125

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

124128
- Core Module
125129
```
126-
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.0'
130+
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.1'
127131
```
128132
- Backend modules
129133
- For backend support, use one of the following supported backend module
130134

131135
```groovy
132136
//For Blockfrost
133-
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.0'
137+
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.1'
134138
135139
//For Koios
136-
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.0'
140+
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.1'
137141
138142
//For Ogmios / Kupo
139-
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.0'
143+
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.1'
140144
141145
```
142146

143147

144148
### For snapshot binaries
145149

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

148152
- For Maven, add the following dependencies and repository to project's pom.xml
149153
```

‎docs/docs/Apis/_category_.json renamed to ‎docs/docs/apis/_category_.json

File renamed without changes.

‎docs/docs/Apis/cip68-api.md renamed to ‎docs/docs/apis/cip68-api.md

File renamed without changes.

‎docs/docs/Apis/governance-api.md renamed to ‎docs/docs/apis/governance-api.md

File renamed without changes.

‎docs/docs/gettingstarted/dependencies.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ sidebar_position: 2
1515
<dependency>
1616
<groupId>com.bloxbean.cardano</groupId>
1717
<artifactId>cardano-client-lib</artifactId>
18-
<version>0.5.0</version>
18+
<version>0.5.1</version>
1919
</dependency>
2020
```
2121
- **Backend modules**
@@ -27,21 +27,21 @@ sidebar_position: 2
2727
<dependency>
2828
<groupId>com.bloxbean.cardano</groupId>
2929
<artifactId>cardano-client-backend-blockfrost</artifactId>
30-
<version>0.5.0</version>
30+
<version>0.5.1</version>
3131
</dependency>
3232

3333
<!-- For Koios backend -->
3434
<dependency>
3535
<groupId>com.bloxbean.cardano</groupId>
3636
<artifactId>cardano-client-backend-koios</artifactId>
37-
<version>0.5.0</version>
37+
<version>0.5.1</version>
3838
</dependency>
3939

4040
<!-- For Ogmios backend -->
4141
<dependency>
4242
<groupId>com.bloxbean.cardano</groupId>
4343
<artifactId>cardano-client-backend-ogmios</artifactId>
44-
<version>0.5.0</version>
44+
<version>0.5.1</version>
4545
</dependency>
4646
```
4747

@@ -50,21 +50,21 @@ sidebar_position: 2
5050
- **Core Module**
5151

5252
```
53-
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.0'
53+
implementation 'com.bloxbean.cardano:cardano-client-lib:0.5.1'
5454
```
5555
- **Backend modules**
5656

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

5959
```groovy
6060
//For Blockfrost
61-
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.0'
61+
implementation 'com.bloxbean.cardano:cardano-client-backend-blockfrost:0.5.1'
6262
6363
//For Koios
64-
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.0'
64+
implementation 'com.bloxbean.cardano:cardano-client-backend-koios:0.5.1'
6565
6666
//For Ogmios
67-
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.0'
67+
implementation 'com.bloxbean.cardano:cardano-client-backend-ogmios:0.5.1'
6868
6969
```
7070

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

7474
:::info
7575

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

7878
:::
7979

‎docs/docs/Guides/_category_.json renamed to ‎docs/docs/guides/_category_.json

File renamed without changes.

‎docs/docs/Guides/nft-minting.md renamed to ‎docs/docs/guides/nft-minting.md

File renamed without changes.

‎docs/docs/Guides/smart-contract-calls.md renamed to ‎docs/docs/guides/smart-contract-calls.md

File renamed without changes.

‎docs/docs/intro.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A client library for Cardano in Java. This library simplifies the interaction wi
88

99
:::info
1010

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

1313
:::
1414

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

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

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

102104
**Following Backend apis are currently available**

‎docs/src/components/HomepageExamples/index.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,6 @@ export default function HomepageExamples() {
150150
<div className="alert alert--success" role="alert">
151151
Simple <strong>declarative</strong> api to build and submit transactions.
152152
<br/>
153-
Supported in <strong>v0.5.0-alpha.3 or later</strong>
154153
</div>
155154
<HomepageExample examples={quickTxExamples}/>
156155
</TabItem>

‎docs/src/components/HomepageFeatures/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const FeatureList = [
2727
description: (
2828
<>
2929
Java Api for <br/>
30-
CIP-8, CIP-20, CIP-25, CIP-30 ...
30+
CIP-8, CIP-20, CIP-25, CIP-30, CIP-67/68 ...
3131
</>
3232
),
3333
},

0 commit comments

Comments
 (0)