diff --git a/README.md b/README.md index cafbb93..7e05f9a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,32 @@ # `bitcoind` JSON-RPC support -Much of the code in this crate was shamelessy stolen from [rust-bitcoincore-rpc -v0.19.0](https://github.com/rust-bitcoin/rust-bitcoincore-rpc). As such I have maintained the -original author's list and added my own name for accountability. All bugs are my own (tcharding). +There are two primary purposes of this repository. + +1. Provide the [`json`](https://crates.io/crates/bitcoind-json-rpc-types) crate for use in + production software. +2. Provide tools to the community for integration testing code written in Rust that interacts with + the Bitcoin network. Primarily consumers of the [`rust-bitcoin`](https://crates.io/crates/bitcoin) + library. And enable doing so against multiple versions of Bitcoin Core. + +If you require a JSON RPC client in production software it is expected you write your own and only +use `json` in your dependency graph. Feel free to copy/steal/plagiarise or otherwise enjoy yourself +with anything in this repository - no attribution required. + +**Please do not use `client` in production and raise bugs, issues, or feature requests.** + +## Crate listing + +- [`json`](https://crates.io/crates/bitcoind-json-rpc-types): Types returned by the JSON-RPC API of Bitcoin Core. +- [`regtest`](https://crates.io/crates/bitcoind-json-rpc-regtest): Runs `bitcoind` regtest nodes. +- [`client`](https://crates.io/crates/bitcoind-json-rpc-client): JSON-RPC client use to test `json`. +- `integration_test`: Integration tests that use `client` and `regtest` to test `json`. + +## Original code + +I don't know who is using `bitcoind` and/or `rust-bitocincore-rpc` in the wild and I do not want to +disrupt them. As such `bitcoind` was pulled in here with permission of the original author. Code +from `rust-bitcoincore-rpc` was just shamelessy stolen. As such I have maintained the original +author's list and added my own name for accountability. All bugs are my own (tcharding). + +- [rust-bitcoincore-rpcv0.19.0](https://github.com/rust-bitcoin/rust-bitcoincore-rpc) +- [`bitcoind`](https://crates.io/crates/bitcoind) \ No newline at end of file