Skip to content

Commit 16087f8

Browse files
bullet-toothdmitry-timofeev
authored andcommitted
Update docs for JLC v0.2.0 [ECR-2920] (#898)
1 parent b08abb0 commit 16087f8

3 files changed

Lines changed: 20 additions & 14 deletions

File tree

exonum-light-client/CHANGELOG.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1515

1616
## Unreleased
1717

18+
## 0.2.0 <!-- Release date placeholder -->
19+
20+
Second release of Exonum Java Light Client which brings
21+
system API and blockhain explorer API endpoints support.
22+
1823
### Versions Support
19-
- Exonum version, 0.11
20-
<!-- TODO: clarify during JLC release (in readme#compatibility) -->
21-
- Exonum Java Binding version, 0.5-SNAPSHOT
24+
- Exonum version, 0.11.0
25+
- Exonum Java Binding version, 0.6.0
2226

2327
### Added
2428
- Support of [System API public][system-api-public] endpoints. (#716)
2529
- Support of [Explorer API][explorer-api] endpoints. (#725, #734)
2630

27-
## 0.1 - 2019-02-18
31+
## 0.1.0 - 2019-02-18
2832

2933
The first release of Exonum Java Light Client.
3034

@@ -38,6 +42,6 @@ This release brings:
3842
- Support of sending transactions to Exonum blockchain nodes.
3943
- Support of Exonum Java Binding Commons library.
4044

41-
[system-api-public]: https://exonum.com/doc/version/latest/advanced/node-management/#public-endpoints
42-
[explorer-api]: https://exonum.com/doc/version/latest/advanced/node-management/#explorer-api-endpoints
45+
[system-api-public]: https://exonum.com/doc/version/0.11/advanced/node-management/#public-endpoints
46+
[explorer-api]: https://exonum.com/doc/version/0.11/advanced/node-management/#explorer-api-endpoints
4347

exonum-light-client/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The following table shows versions compatibility:
2525

2626
| Light Client | Exonum | Exonum Java |
2727
|--------------|--------|-------------|
28+
| 0.2.0 | 0.11.0 | 0.6.0 |
2829
| 0.1.0 | 0.10.* | 0.4 |
2930

3031
## System Dependencies
@@ -37,15 +38,18 @@ If you are using Maven, add this to your _pom.xml_ file
3738
<dependency>
3839
<groupId>com.exonum.client</groupId>
3940
<artifactId>exonum-light-client</artifactId>
40-
<version>0.1.0</version>
41+
<version>0.2.0</version>
4142
</dependency>
4243
```
4344
If you are using Gradle, add this to your dependencies
4445
```Groovy
45-
compile 'com.exonum.client:exonum-light-client:0.1.0'
46+
compile 'com.exonum.client:exonum-light-client:0.2.0'
4647
```
4748

4849
## Examples
50+
This section contains most frequently used operations with the blockchain.
51+
Please navigate to [Exonum client][exonum-client] API documentation
52+
to see all supported operations.
4953

5054
### Exonum Client Initialization
5155
The following example shows how to create the instance of exonum client
@@ -105,8 +109,6 @@ for the full example of how to create a transaction message and
105109
send it to Exonum node.
106110

107111
### Transaction Info
108-
<!-- TODO: remove after release -->
109-
_*Not available for Light Client v0.1_
110112
The following method provides a possibility to get information
111113
on a transaction by its hash - status of the transaction,
112114
details of the message containing the transaction and,
@@ -132,9 +134,9 @@ which is required for the client.
132134
Apache 2.0 - see [LICENSE](../LICENSE) for more information.
133135

134136
[exonum]: https://github.com/exonum/exonum
135-
[ejb-common]: https://exonum.com/doc/api/java-binding-common/0.4/
136-
[exonum-tx-message-builder]: https://exonum.com/doc/api/java-binding-common/0.4/com/exonum/binding/common/message/TransactionMessage.Builder.html
137+
[ejb-common]: https://exonum.com/doc/api/java-binding-common/0.6.0/
138+
[exonum-tx-message-builder]: https://exonum.com/doc/api/java-binding-common/0.6.0/com/exonum/binding/common/message/TransactionMessage.Builder.html
137139
[protobuf]: https://developers.google.com/protocol-buffers/docs/proto3
138-
[standard-serializers]: https://exonum.com/doc/api/java-binding-common/0.4/com/exonum/binding/common/serialization/StandardSerializers.html
140+
[standard-serializers]: https://exonum.com/doc/api/java-binding-common/0.6.0/com/exonum/binding/common/serialization/StandardSerializers.html
139141
[send-tx-it]: ./src/test/java/com/exonum/client/ExonumHttpClientIntegrationTest.java
140142
[exonum-client]: ./src/main/java/com/exonum/client/ExonumClient.java

exonum-light-client/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161

6262
<properties>
6363
<!-- Project configuration -->
64-
<ejb.version>0.5.0</ejb.version>
64+
<ejb.version>0.6.0</ejb.version>
6565
<java.compiler.source>8</java.compiler.source>
6666
<java.compiler.target>8</java.compiler.target>
6767
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

0 commit comments

Comments
 (0)