From 2243ad5bf53e58f7c401c40a802e2d3510897b38 Mon Sep 17 00:00:00 2001 From: Boyu Yang Date: Wed, 20 Mar 2024 07:33:17 +0800 Subject: [PATCH] docs: initial commit --- .gitignore | 0 LICENSE | 19 +++++++++++++++++++ README.md | 28 ++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1e6096c --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2024 Boyu Yang + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..41fe3d6 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# CKB Bitcoin SPV Service + +[![License]](#license) + +> [!WARNING] +> This repository is still in the proof-of-concept stage. + +A service, which synchronizes [Bitcoin] headers to a [Bitcoin SPV on CKB] +and provides an API to generate proofs for [Bitcoin] transactions so that +they can be verified on [CKB]. + +[License]: https://img.shields.io/badge/License-MIT-blue.svg + +## Related Projects + +- [The Core Library of CKB Bitcoin SPV][Bitcoin SPV on CKB] + +- [The CKB Bitcoin SPV Contracts](https://github.com/ckb-cell/ckb-bitcoin-spv-contracts) + +## License + +Licensed under [MIT License]. + +[Bitcoin]: https://bitcoin.org +[CKB]: https://github.com/nervosnetwork/ckb +[Bitcoin SPV on CKB]: https://github.com/ckb-cell/ckb-bitcoin-spv + +[MIT License]: LICENSE