zecfoundation
/
rust-bitcoin
mirror of https://github.com/ZcashFoundation/rust-bitcoin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Slightly update README

This commit is contained in:
Steven Roose 2019-06-06 10:46:46 +01:00
parent 08c756d20e
commit 0343559ae0
No known key found for this signature in database
GPG Key ID: 2F2A88D7F8D68E87
1 changed files with 29 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -3,8 +3,7 @@
# Rust Bitcoin Library # Rust Bitcoin Library
Library with support for de/serialization, parsing and executing on data Library with support for de/serialization, parsing and executing on data
structures and network messages related to Bitcoin and other blockchain-based structures and network messages related to Bitcoin.
currencies.
[Documentation](https://docs.rs/bitcoin/) [Documentation](https://docs.rs/bitcoin/)
@ -14,11 +13,11 @@ Supports (or should support)
* De/serialization of blocks and transactions * De/serialization of blocks and transactions
* Script de/serialization * Script de/serialization
* Private keys and address creation, de/serialization and validation (including full BIP32 support) * Private keys and address creation, de/serialization and validation (including full BIP32 support)
* PSBT creation, manipulation, merging and finalization
* Pay-to-contract support as in Appendix A of the [Blockstream sidechains whitepaper](https://www.blockstream.com/sidechains.pdf) * Pay-to-contract support as in Appendix A of the [Blockstream sidechains whitepaper](https://www.blockstream.com/sidechains.pdf)
For JSONRPC interaction with Bitcoin Core, it is recommended to use [rust-jsonrpc](https://github.com/apoelstra/rust-jsonrpc) For JSONRPC interaction with Bitcoin Core, it is recommended to use
which uses the underlying [strason library](https://github.com/apoelstra/strason) [rust-bitcoincore-rpc](https://github.com/rust-bitcoin/rust-bitcoincore-rpc).
which parses decimal numbers as strings, preventing precision errors.
# Known limitations # Known limitations
@ -38,20 +37,25 @@ fix specific consensus incompatibilities are welcome.
## Documentation ## Documentation
Currently the [documentation](https://www.wpsoftware.net/rustdoc/bitcoin/) Currently can be found on [docs.rs/bitcoin](https://docs.rs/bitcoin/).
is very sparse. Patches to add usage examples and to expand on existing Patches to add usage examples and to expand on existing docs would be extremely
docs would be extremely appreciated. appreciated.
# Contributing # Contributing
Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before PRing Contributions are generally welcome. If you intend to make larger changes please
them to avoid duplicate work and architectural mismatches. If you have any questions or ideas you want to discuss discuss them in an issue before PRing them to avoid duplicate work and
please join us in [#rust-bitcoin](http://webchat.freenode.net/?channels=%23rust-bitcoin) on freenode. architectural mismatches. If you have any questions or ideas you want to discuss
please join us in
[#rust-bitcoin](http://webchat.freenode.net/?channels=%23rust-bitcoin) on
freenode.
## Installing Rust ## Installing Rust
Rust can be installed using your package manager of choice or [rustup.rs](https://rustup.rs). The former way is Rust can be installed using your package manager of choice or
considered more secure since it typically doesn't involve trust in the CA system. But you should be aware that the version [rustup.rs](https://rustup.rs). The former way is considered more secure since
of Rust shipped by your distribution might be out of date. Generally this isn't a problem for `rust-bitcoin` since it typically doesn't involve trust in the CA system. But you should be aware
we support much older versions (>=1.22) than the current stable one. that the version of Rust shipped by your distribution might be out of date.
Generally this isn't a problem for `rust-bitcoin` since we support much older
versions (>=1.22) than the current stable one.
## Building ## Building
The library can be built and tested using [`cargo`](https://github.com/rust-lang/cargo/): The library can be built and tested using [`cargo`](https://github.com/rust-lang/cargo/):
@ -71,9 +75,11 @@ cargo test
Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions. Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions.
## Pull Requests ## Pull Requests
Every PR needs at least two reviews to get merged. During the review phase maintainers and contributors are likely to Every PR needs at least two reviews to get merged. During the review phase
leave comments and request changes. Please try to address them, otherwise your PR might get closed without merging after maintainers and contributors are likely to leave comments and request changes.
a longer time of inactivity. If your PR isn't ready for review yet please mark it by prefixing the title with `WIP: `. Please try to address them, otherwise your PR might get closed without merging
after a longer time of inactivity. If your PR isn't ready for review yet please
mark it by prefixing the title with `WIP: `.
## Policy on Altcoins/Altchains ## Policy on Altcoins/Altchains
@ -93,3 +99,8 @@ support only a single blockchain.
See CHANGELOG.md See CHANGELOG.md
# Licensing
The code in this project is licensed under the Creative Commons CC0 1.0
Universal license.