Skip to content

Commit

Permalink
docs: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
yangby-cryptape committed Mar 19, 2024
0 parents commit 2243ad5
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 0 deletions.
Empty file added .gitignore
Empty file.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2024 Boyu Yang <[email protected]>

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.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2243ad5

Please sign in to comment.