Skip to content

Commit 305d3f9

Browse files
authored
Merge pull request #443 from kyonRay/master
<doc>(README): update README and README_EN.
2 parents 5bd63de + 50898e1 commit 305d3f9

File tree

3 files changed

+97
-30
lines changed

3 files changed

+97
-30
lines changed

Diff for: README.md

+35-30
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
![](docs/images/FISCO_BCOS_Logo.svg)
1+
![](./docs/FISCO_BCOS_Logo.svg)
22

3-
English / [中文](docs/README_CN.md)
3+
[English](./docs/README_EN.md) / 中文
44

55
# Java SDK
66

@@ -9,41 +9,46 @@ English / [中文](docs/README_CN.md)
99
[![CodeFactor](https://www.codefactor.io/repository/github/fisco-bcos/java-sdk/badge)](https://www.codefactor.io/repository/github/fisco-bcos/java-sdk)
1010
[![GitHub All Releases](https://img.shields.io/github/downloads/FISCO-BCOS/java-sdk/total.svg)](https://github.com/FISCO-BCOS/java-sdk)
1111

12-
This is the FISCO BCOS Client SDK for Java. Developers can use Java SDK to build blockchain applications with FISCO BCOS blockchain.
12+
这是FISCO BCOS客户端的Java SDK,提供了访问FISCO BCOS节点的Java API,支持节点状态查询、部署和调用合约等功能,基于Java SDK可开发区块链应用,目前支持FISCO BCOS 2.0+。
1313

14-
## Functions
15-
* Contract compiling.
16-
* Interacting with FISCO BCOS JSON-RPC interface.
17-
* constructing and sending transactions.
18-
* Advanced Messages Onchain Protocol(AMOP) functions.
19-
* Contract event subscription.
20-
* Encoding and decoding data with ABI.
21-
* Account Management.
14+
## 功能
15+
* 提供合约编译功能,将Solidity合约文件转换成Java合约文件。
16+
* 支持Liquid合约使用,包含部署Liquid合约,发起Liquid合约交易。
17+
* 提供Java SDK API,提供访问FISCO BCOS JSON-RPC 的功能,并支持预编译(Precompiled)合约调用。
18+
* 提供自定义构造和发送交易功能。
19+
* 提供AMOP功能。
20+
* 支持合约事件推送。
21+
* 支持ABI和Scale的编解码解析。
22+
* 提供账户管理接口。
23+
* 提供权限管理接口。
2224

23-
## New Features
24-
This java sdk is a code refactoring version base on web3sdk (not recommend to use), it includes the following new features:
25+
## 新特性
26+
Java SDK包含如下几个新特性:
2527

26-
* Support Toml config file, simplify configuration options.
27-
* Support connecting with nodes of different groups.
28-
* Support AMOP subscription and unsubscription at any time instead of just before start service.
29-
* ABI module add support of encode and decode of struct type data.
30-
* Use the common crypto tools of WeBank.
31-
* Add a new module called group management to help applications manage nodes which java SDK connecting with.
32-
* Use modular design, each module can use independently. For example, you can create crypto.jar file if only crypto module is needed.
28+
* 完全支持 [FISCO BCOS 3.0+](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/).
29+
* 支持Liquid合约使用,包含部署Liquid合约,发起Liquid合约交易。
30+
* 支持Scale的编解码解析。
31+
* 使用JNI封装后的[FISCO BCOS C SDK](https://github.com/FISCO-BCOS/bcos-c-sdk)接口与区块链交互。
3332

34-
## Documentation
35-
* [English User Manual](https://fisco-bcos-documentation.readthedocs.io/en/latest/docs/sdk/java_sdk/index.html)
36-
* [Chinese User Manual](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk/index.html)
37-
* [Chinese WIKI](https://github.com/FISCO-BCOS/java-sdk/wiki)
33+
## 文档
34+
* [中文版用户手册](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/index.html)
35+
* 英文版用户手册: 施工中...
3836

39-
## Quick Start
40-
* [Chinese](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk/quick_start.html)
37+
## 快速开始
38+
* [中文版手册](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/java_sdk/quick_start.html)
4139

42-
## Join Our Community
40+
## 贡献代码
41+
欢迎参与FISCO BCOS的社区建设:
42+
- 点亮我们的小星星(点击项目左上方Star按钮)。
43+
- 提交代码(Pull requests),参考我们的 [代码贡献流程](https://mp.weixin.qq.com/s/_w_auH8X4SQQWO3lhfNrbQ)
44+
- [提问和提交BUG](https://github.com/FISCO-BCOS/java-sdk/issues)
4345

44-
The FISCO BCOS community is one of the most active open-source blockchain communities in China. It provides long-term technical support for both institutional and individual developers and users of FISCO BCOS. Thousands of technical enthusiasts from numerous industry sectors have joined this community, studying and using FISCO BCOS platform. If you are also interested, you are most welcome to join us for more support and fun.
46+
## 加入我们的社区
47+
48+
FISCO BCOS开源社区是国内活跃的开源社区,社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣,欢迎加入社区获得更多支持与帮助。
4549

4650
## License
47-
![license](http://img.shields.io/badge/license-Apache%20v2-blue.svg)
4851

49-
All contributions are made under the [Apache License 2.0](http://www.apache.org/licenses/). See [LICENSE](LICENSE).
52+
![license](https://img.shields.io/badge/license-Apache%20v2-blue.svg)
53+
54+
Web3SDK的开源协议为[Apache License 2.0](http://www.apache.org/licenses/). 详情参考[LICENSE](../LICENSE)

Diff for: docs/FISCO_BCOS_Logo.svg

+15
Loading

Diff for: docs/README_EN.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
![](docs/images/FISCO_BCOS_Logo.svg)
2+
3+
English / [中文](docs/README_CN.md)
4+
5+
# Java SDK
6+
7+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
8+
[![Build Status](https://travis-ci.org/FISCO-BCOS/java-sdk.svg?branch=master)](https://travis-ci.org/FISCO-BCOS/java-sdk)
9+
[![CodeFactor](https://www.codefactor.io/repository/github/fisco-bcos/java-sdk/badge)](https://www.codefactor.io/repository/github/fisco-bcos/java-sdk)
10+
[![GitHub All Releases](https://img.shields.io/github/downloads/FISCO-BCOS/java-sdk/total.svg)](https://github.com/FISCO-BCOS/java-sdk)
11+
12+
This is the FISCO BCOS Client SDK for Java. Developers can use Java SDK to build blockchain applications with FISCO BCOS blockchain.
13+
14+
## Functions
15+
* Solidity contract compiling.
16+
* Liquid contract support, including deploy contracts, sending transactions.
17+
* Interacting with FISCO BCOS JSON-RPC interface.
18+
* Constructing and sending transactions.
19+
* Advanced Messages Onchain Protocol(AMOP) functions.
20+
* Contract event subscription.
21+
* Encoding and decoding data with ABI and Scale.
22+
* Account Management.
23+
* Authority Management.
24+
25+
## New Features
26+
Java SDK includes the following new features:
27+
28+
* Support [FISCO BCOS 3.0+](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/).
29+
* Support Liquid usage, including deploy contracts, sending transactions.
30+
* Support Scale encoding and decoding data.
31+
* Use JNI wrapper of [FISCO BCOS C SDK](https://github.com/FISCO-BCOS/bcos-c-sdk) interface, which connecting blockchain nodes.
32+
33+
## Documentation
34+
* English User Manual: in progress...
35+
* [Chinese User Manual](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/index.html)
36+
37+
## Quick Start
38+
* [Chinese](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/java_sdk/quick_start.html)
39+
40+
## Join Our Community
41+
42+
The FISCO BCOS community is one of the most active open-source blockchain communities in China. It provides long-term technical support for both institutional and individual developers and users of FISCO BCOS. Thousands of technical enthusiasts from numerous industry sectors have joined this community, studying and using FISCO BCOS platform. If you are also interested, you are most welcome to join us for more support and fun.
43+
44+
## License
45+
![license](http://img.shields.io/badge/license-Apache%20v2-blue.svg)
46+
47+
All contributions are made under the [Apache License 2.0](http://www.apache.org/licenses/). See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)