bitxhub/README.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

2020-03-30 18:46:49 +08:00
<p align="center">
<img src="https://raw.githubusercontent.com/meshplus/bitxhub/master/docs/logo.png" />
</p>
2020-03-29 21:32:01 +08:00
![build](https://github.com/meshplus/bitxhub/workflows/build/badge.svg)
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)
2020-03-30 21:51:48 +08:00
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.
2020-03-30 01:40:47 +08:00
## Quick start
See [Quick start](https://github.com/meshplus/bitxhub/wiki/Quick-start) in the wiki.
2020-03-31 14:00:16 +08:00
## Architecture
2020-03-30 01:40:47 +08:00
2020-03-31 14:00:16 +08:00
<p>
<img src="https://github.com/meshplus/bitxhub/blob/master/docs/arch.png" />
</p>
2020-03-30 01:40:47 +08:00
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.
2020-03-29 21:32:01 +08:00
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).
2020-03-29 21:32:01 +08:00
2020-03-30 18:46:49 +08:00
## Usage
2020-03-29 21:32:01 +08:00
2020-03-31 14:00:16 +08:00
Usage guide can be found in [wiki](https://github.com/meshplus/bitxhub/wiki).
2020-03-29 21:32:01 +08:00
2020-03-30 01:40:47 +08:00
## Contributing
2020-03-29 21:32:01 +08:00
2020-03-30 01:40:47 +08:00
See [CONTRIBUTING.md](https://github.com/meshplus/bitxhub/blob/master/CONTRIBUTING.md).
2020-03-29 21:32:01 +08:00
2020-03-30 18:46:49 +08:00
## Contact
2019-10-24 22:04:43 +08:00
2020-03-30 18:46:49 +08:00
Email: bitxhub@hyperchain.cn
2020-03-31 14:00:16 +08:00
Wechat: If youre interested in BitXHub, please add the assistant to join our community group.
2020-03-30 18:46:49 +08:00
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" />
2020-03-31 14:00:16 +08:00
2020-03-30 01:40:47 +08:00
## License
2020-03-29 21:32:01 +08:00
2020-03-30 21:51:48 +08:00
[Apache-2.0](https://github.com/meshplus/bitxhub/blob/master/LICENSE)