Skip to content

Commit

Permalink
Merge pull request #2 from meshplus/docs/update-readme
Browse files Browse the repository at this point in the history
docs(readme):update README.md
  • Loading branch information
jzhe886 authored Mar 31, 2020
2 parents 5f0251a + c9a89ab commit 18dcf58
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Go Bitxhub Client
Java Bitxhub Client
=====

This SDK enables Java developers to build solutions that interact with BitXHub.

## Prepare
You need to have the following dependencies installed on your machine.
- [__Java8+__](https://www.oracle.com/java/technologies/javase-downloads.html)
- [__Maven3.6+__](https://maven.apache.org/download.cgi)
- [__Maven3.3+__](https://maven.apache.org/download.cgi)

## Getting started
Obtain the client SDK packages for BitXHub.
Expand All @@ -23,10 +23,6 @@ Then you can get the `java-bitxhub-client-0.1.0-jar-with-dependencies.jar` in th

You're good to go, happy coding! Check out the examples for usage demonstrations.

### Documentation

SDK documentation can be viewed at [JavaDoc](https://github.com/meshplus/java-bitxhub-client/wiki/Java-SDK%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3).

### Examples

- [RPC Test](src/test/java/cn/dmlab/bitxhub/RPCTest.java): Basic example that uses SDK to query and execute transaction.
Expand All @@ -35,11 +31,16 @@ SDK documentation can be viewed at [JavaDoc](https://github.com/meshplus/java-bi
- [Subscribe Test](src/test/java/cn/dmlab/bitxhub/SubscribeTest.java): An example that uses SDK to subscribe the block event.
- [Sync Test](src/test/java/cn/dmlab/bitxhub/SyncTest.java): An example that uses SDK to sync the merkle wrapper.
- [Appchain Test](src/test/java/cn/dmlab/bitxhub/AppchainTest.java): Basic example that uses SDK to register and adult appchain.

### Documentation

SDK documentation can be viewed at [JavaDoc](https://github.com/meshplus/java-bitxhub-client/wiki/Java-SDK%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3).

## Client SDK
You should start [BitXHub](https://github.com/meshplus/bitxhub) before using SDK.

### Running the test
Obtain the client SDK packages for BitXHub.

```shell script
# In the BitXHub SDK Java directory
cd java-bitxhub-client/
Expand Down

0 comments on commit 18dcf58

Please sign in to comment.