From f869503dd7aa697a2fb134fb965e02ab4ebbd49a Mon Sep 17 00:00:00 2001 From: Liu-Cheng Xu Date: Wed, 3 Jul 2024 23:52:06 +0800 Subject: [PATCH] Update README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2eaff63cb867b..9d70d315dfbab 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# subcoin -Bitcoin Node in Substrate +# Subcoin: Bitcoin Full Node in Substrate + +[![Continuous integration](https://github.com/subcoin-project/subcoin/actions/workflows/ci.yml/badge.svg)](https://github.com/subcoin-project/subcoin/actions/workflows/ci.yml) + +> [!WARNING] +> +> Subcoin is currently in its early development stages and is not yet ready for production use. +> See [the disclaimer below](#disclaimer). + +## Overview + +Subcoin is a full node implementation of Bitcoin in Rust, built using the Substrate framework. +By leveraging Substrate's modular and flexible architecture, Subcoin aims to offer a robust +and performant implementation of Bitcoin protocol. + +Currently, Subcoin only implements the feature of syncing as a full node. It is not yet capable +of participating in the Bitcoin consensus as a miner node. Additional features are in the +planning stages. + +## Pros + +- 🔄 **Fast Sync**. Employs Substrate's advanced state sync strategy, enabling Bitcoin fast sync +by downloading all headers and the state at a specific block. +- 🔗 **Substrate Integration**: Utilizes Substrate framework provide production-level blockchain infrastructures. + +## Disclaimer + +**Do not use Subcoin in production.** It is a heavy work in progress, not feature-complete and the code +has not been audited as well. Use at your own risk. + +## Contributing + +Contributions to Subcoin are welcome! If you have ideas for improvements, bug fixes, or new features, +feel free to open an issue or submit a pull request. Make sure to follow the contribution guidelines +and code of conduct when contributing to the project. + +## License + +Subcoin is licensed under the [MIT License](LICENSE). See the LICENSE file for information.