Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit 4b0bd28

Browse files
authored
Merge pull request #18 from tcharding/08-08-fix-readme
Improve README
2 parents fd860bb + ab4afeb commit 4b0bd28

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
There are two primary purposes of this repository.
44

5-
1. Provide the [`json`](https://crates.io/crates/bitcoind-json-rpc-types) crate for use in
6-
production software.
5+
1. Provide the [`bitcoind-json-rpc-types`](https://crates.io/crates/bitcoind-json-rpc-types) crate
6+
for use in production software.
77
2. Provide tools to the community for integration testing code written in Rust that interacts with
88
the Bitcoin network. Primarily consumers of the [`rust-bitcoin`](https://crates.io/crates/bitcoin)
99
library. And enable doing so against multiple versions of Bitcoin Core.
1010

1111
If you require a JSON RPC client in production software it is expected you write your own and only
12-
use `json` in your dependency graph. Feel free to copy/steal/plagiarise or otherwise enjoy yourself
13-
with anything in this repository - no attribution required.
12+
use the `bitcoind-json-rpc-types` crate in your dependency graph. Feel free to copy/steal/plagiarise
13+
or otherwise enjoy yourself with anything in this repository - no attribution required.
1414

1515
**Please do not use `client` in production and raise bugs, issues, or feature requests.**
1616

1717
## Crate listing
1818

19-
- [`json`](https://crates.io/crates/bitcoind-json-rpc-types): Types returned by the JSON-RPC API of Bitcoin Core.
19+
- [`json`](https://crates.io/crates/bitcoind-json-rpc-types): Rust types returned by the JSON-RPC API of Bitcoin Core (`bitcoind-json-rpc-types`).
2020
- [`regtest`](https://crates.io/crates/bitcoind-json-rpc-regtest): Runs `bitcoind` regtest nodes.
21-
- [`client`](https://crates.io/crates/bitcoind-json-rpc-client): JSON-RPC client use to test `json`.
21+
- [`client`](https://crates.io/crates/bitcoind-json-rpc-client): A blocking JSON-RPC client used to test `bitcoind-json-rpc-types`.
2222
- `integration_test`: Integration tests that use `client` and `regtest` to test `json`.
2323

2424
## Original code

0 commit comments

Comments
 (0)