openatom_foundation
/
bitxhub
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
bitxhub/README.md

50 lines
1.9 KiB
Markdown
Raw Normal View History

docs(README.md): add wechat
2020-03-30 18:46:49 +08:00
<p align="center">
<img src="https://raw.githubusercontent.com/meshplus/bitxhub/master/docs/logo.png" />
</p>
feat(*): init project
2020-03-29 21:32:01 +08:00
docs(README.md): add build passing badge
2020-03-30 22:00:13 +08:00
![build](https://github.com/meshplus/bitxhub/workflows/build/badge.svg)
build(ci): add codecov
2020-04-01 02:06:24 +08:00
[![codecov](https://codecov.io/gh/meshplus/bitxhub/branch/master/graph/badge.svg)](https://codecov.io/gh/meshplus/bitxhub)
build(ci): add go report card
2020-04-01 02:30:38 +08:00
[![Go Report Card](https://goreportcard.com/badge/github.com/meshplus/bitxhub)](https://goreportcard.com/report/github.com/meshplus/bitxhub)
docs(README.md): add build badge
2020-03-30 21:51:48 +08:00
feat(*): init project
2020-03-29 21:32:01 +08:00
BitXHub is committed to building a scalable, robust, and pluggable inter-blockchain
reference implementation, that can provide reliable technical support for the formation
of a blockchain internet and intercommunication of value islands.
chore(*): modify README.md
2020-03-30 01:40:47 +08:00
## Quick start
See [Quick start](https://github.com/meshplus/bitxhub/wiki/Quick-start) in the wiki.
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
## Architecture
chore(*): modify README.md
2020-03-30 01:40:47 +08:00
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
<p>
<img src="https://github.com/meshplus/bitxhub/blob/master/docs/arch.png" />
</p>
chore(*): modify README.md
2020-03-30 01:40:47 +08:00
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
The diagram above shows the overall architecture and basic interchain processing workflow of BitXHub. BitXHub consists of relay-chain, Pier (interchain gateway) and app-chain, which is a service platform to handle the interaction among cross-layer heterogeneous chains.
feat(*): init project
2020-03-29 21:32:01 +08:00
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
For more details please visit our [whitepaper](https://upload.hyperchain.cn/BitXHub%20Whitepaper.pdf) | [白皮书](https://upload.hyperchain.cn/BitXHub%E7%99%BD%E7%9A%AE%E4%B9%A6.pdf).
feat(*): init project
2020-03-29 21:32:01 +08:00
docs(README.md): add wechat
2020-03-30 18:46:49 +08:00
## Usage
feat(*): init project
2020-03-29 21:32:01 +08:00
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
Usage guide can be found in [wiki](https://github.com/meshplus/bitxhub/wiki).
feat(*): init project
2020-03-29 21:32:01 +08:00
chore(*): modify README.md
2020-03-30 01:40:47 +08:00
## Contributing
feat(*): init project
2020-03-29 21:32:01 +08:00
chore(*): modify README.md
2020-03-30 01:40:47 +08:00
See [CONTRIBUTING.md](https://github.com/meshplus/bitxhub/blob/master/CONTRIBUTING.md).
feat(*): init project
2020-03-29 21:32:01 +08:00
docs(README.md): add wechat
2020-03-30 18:46:49 +08:00
## Contact
chore(*): add README.md
2019-10-24 22:04:43 +08:00
docs(README.md): add wechat
2020-03-30 18:46:49 +08:00
Email: bitxhub@hyperchain.cn
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
Wechat: If you‘re interested in BitXHub, please add the assistant to join our community group.
docs(README.md): add wechat
2020-03-30 18:46:49 +08:00
docs(README.md): update official size
2020-03-31 16:44:45 +08:00
<img src="https://github.com/meshplus/bitxhub/blob/master/docs/wechat.png" width="200" /><img src="https://github.com/meshplus/bitxhub/blob/master/docs/official.png" width="206" />
docs(README.md): add arch png
2020-03-31 14:00:16 +08:00
chore(*): modify README.md
2020-03-30 01:40:47 +08:00
## License
feat(*): init project
2020-03-29 21:32:01 +08:00
docs(README.md): add build badge
2020-03-30 21:51:48 +08:00
[Apache-2.0](https://github.com/meshplus/bitxhub/blob/master/LICENSE)