From 0343559ae01a960aaaa58bf10770799a1dc2ead5 Mon Sep 17 00:00:00 2001 From: Steven Roose Date: Thu, 6 Jun 2019 10:46:46 +0100 Subject: [PATCH] Slightly update README --- README.md | 47 +++++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 692344f..53df6e1 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ # Rust Bitcoin Library Library with support for de/serialization, parsing and executing on data -structures and network messages related to Bitcoin and other blockchain-based -currencies. +structures and network messages related to Bitcoin. [Documentation](https://docs.rs/bitcoin/) @@ -14,11 +13,11 @@ Supports (or should support) * De/serialization of blocks and transactions * Script de/serialization * 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) -For JSONRPC interaction with Bitcoin Core, it is recommended to use [rust-jsonrpc](https://github.com/apoelstra/rust-jsonrpc) -which uses the underlying [strason library](https://github.com/apoelstra/strason) -which parses decimal numbers as strings, preventing precision errors. +For JSONRPC interaction with Bitcoin Core, it is recommended to use +[rust-bitcoincore-rpc](https://github.com/rust-bitcoin/rust-bitcoincore-rpc). # Known limitations @@ -38,20 +37,25 @@ fix specific consensus incompatibilities are welcome. ## Documentation -Currently the [documentation](https://www.wpsoftware.net/rustdoc/bitcoin/) -is very sparse. Patches to add usage examples and to expand on existing -docs would be extremely appreciated. +Currently can be found on [docs.rs/bitcoin](https://docs.rs/bitcoin/). +Patches to add usage examples and to expand on existing docs would be extremely +appreciated. # Contributing -Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before PRing -them to avoid duplicate work and 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. +Contributions are generally welcome. If you intend to make larger changes please +discuss them in an issue before PRing them to avoid duplicate work and +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 -Rust can be installed using your package manager of choice or [rustup.rs](https://rustup.rs). The former way is -considered more secure since it typically doesn't involve trust in the CA system. But you should be aware 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. +Rust can be installed using your package manager of choice or +[rustup.rs](https://rustup.rs). The former way is considered more secure since +it typically doesn't involve trust in the CA system. But you should be aware +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 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. ## Pull Requests -Every PR needs at least two reviews to get merged. During the review phase maintainers and contributors are likely to -leave comments and request changes. 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: `. +Every PR needs at least two reviews to get merged. During the review phase +maintainers and contributors are likely to leave comments and request changes. +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 @@ -93,3 +99,8 @@ support only a single blockchain. See CHANGELOG.md + +# Licensing + +The code in this project is licensed under the Creative Commons CC0 1.0 +Universal license.