Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 1ecfa1a

Browse files
committed
[doc] update logo and content of README.md
1 parent 80732d4 commit 1ecfa1a

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img alt="am logo" src="https://gw.alipayobjects.com/zos/bmw-prod/3ee4adc7-1960-4dbf-982e-522ac135a0c0.svg" width="250" >
2+
<img alt="am logo" src="https://antchainbridge.oss-cn-shanghai.aliyuncs.com/antchainbridge/document/picture/antchain.png" width="250" >
33
<h1 align="center">AntChain Bridge Plugin Server</h1>
44
<p align="center">
55
<a href="http://makeapullrequest.com">
@@ -17,7 +17,7 @@
1717
</p>
1818
</div>
1919

20-
# Introduction
20+
# 介绍
2121

2222
AntChain Bridge 插件服务(PluginServer, PS)用于管理异构链插件、完成与中继通信的工作。
2323

@@ -29,32 +29,32 @@ AntChain Bridge 插件服务(PluginServer, PS)用于管理异构链插件、
2929

3030
将PS注册到一个中继之后,PS会作为一个RPC Server为中继提供服务,PS和中继之间会建立双向认证的TLS连接,确保身份互认和安全性,中继会发送请求要求PS完成BBC对象初始化等工作,并调用BBC的接口,完成与异构链的交互。
3131

32-
# Architecture
32+
# 架构
3333

3434
下面介绍了中继服务的整体架构。
3535

3636
**以下插件BCOS和插件ChainMaker均为展示用例,代表不同的异构插件实现*
3737

3838
<img src="https://antchainbridge.oss-cn-shanghai.aliyuncs.com/antchainbridge/document/picture/1677744080321-3622114c-52c2-432c-9ceb-0f3d07c290e4.jpeg" style="zoom:33%;" alt=""/>
3939

40-
# Get Started
40+
# 快速开始
4141

42-
## Build
42+
## 构建
4343

4444
进入代码的根目录,运行mvn编译即可:
4545

4646
```shell
4747
mvn clean package
4848
```
4949

50-
产生的安装包在`ps-bootstrap/target/plugin-server-0.1.0-SNAPSHOT.tar.gz`
50+
产生的安装包在`ps-bootstrap/target/plugin-server-0.1.2-SNAPSHOT.tar.gz`
5151

52-
## Configuration
52+
## 配置
5353

54-
在获得安装包之后,执行解压缩操作,这里以`plugin-server-0.1.0-SNAPSHOT.tar.gz`为例。
54+
在获得安装包之后,执行解压缩操作,这里以`plugin-server-0.1.2-SNAPSHOT.tar.gz`为例。
5555

5656
```
57-
tar -zxf plugin-server-0.1.0-SNAPSHOT.tar.gz
57+
tar -zxf plugin-server-0.1.2-SNAPSHOT.tar.gz
5858
```
5959

6060
进入解压后的目录,可以看到:
@@ -72,7 +72,7 @@ tree .
7272
├── config
7373
│   └── application.yml
7474
└── lib
75-
   └── ps-bootstrap-0.1.0-SNAPSHOT.jar
75+
   └── ps-bootstrap-0.1.2-SNAPSHOT.jar
7676
7777
7878
3 directories, 7 files
@@ -122,7 +122,7 @@ pluginserver:
122122

123123
将您的插件都放到这个路径下即可。
124124

125-
## Run
125+
## 运行
126126

127127
在解压包根目录之下,运行一下命令即可:
128128

@@ -148,17 +148,36 @@ pluginserver:
148148
149149
日志文件存储在`log`目录之下。
150150
151-
## Run Test
151+
## 运行测试
152152
153153
在运行测试之前,请使用`ps-bootstrap/src/main/resources/scripts/init_tls_certs.sh`生成证书,并将`server.key`和`server.crt` 放到`ps-bootstrap/src/test/resources`之下,运行下述命令即可运行测试用例:
154154
155155
```
156156
mvn test
157157
```
158158
159-
# CLI Usage
159+
# CLI
160160
161-
敬请期待
161+
*我们将在不久之后提供一个CLI工具,用于管理插件服务。*
162+
163+
164+
# 社区治理
165+
166+
AntChain Bridge 欢迎您以任何形式参与社区建设。
167+
168+
您可以通过以下方式参与社区讨论
169+
170+
- 钉钉
171+
172+
![scan dingding](https://antchainbridge.oss-cn-shanghai.aliyuncs.com/antchainbridge/document/picture/dingding.png)
173+
174+
- 微信
175+
176+
![scan_wechat](https://antchainbridge.oss-cn-shanghai.aliyuncs.com/antchainbridge/document/picture/wechat.png)
177+
178+
- 邮件
179+
180+
发送邮件到`[email protected]`
162181
163182
# License
164183

0 commit comments

Comments
 (0)