Skip to content

Commit bf7415f

Browse files
committed
Update the README file with the new templates
Add a section for the contrib and verify folders. Remove trailing spaces. Reorder the directory listing alphabetically.
1 parent a651062 commit bf7415f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
There are two primary purposes of this repository:
44

55
1. Provide the [`corepc-types`](https://crates.io/crates/corepc-types) crate for use in production
6-
software.
7-
6+
software.
7+
88
2. Provide tools for integration testing Rust code that interacts with the Bitcoin network.
99
Primarily consumers of the [`rust-bitcoin`](https://crates.io/crates/bitcoin) library. And enable
1010
doing so against multiple versions of Bitcoin Core.
@@ -24,11 +24,13 @@ integration testing.
2424

2525
## Crate/directory listing
2626

27-
- `types/`: [`corepc-types`](https://crates.io/crates/corepc-types): Rust types returned by the JSON-RPC API of Bitcoin Core.
28-
- `node/`: [`corepc-node`](https://crates.io/crates/corepc-node): Runs `bitcoind` regtest nodes.
2927
- `client/`: [`corepc-client`](https://crates.io/crates/corepc-client): A blocking JSON-RPC client used to test `corepc-types`.
28+
- `contrib/`: Contains scripts including one to run local regtest `bitcoind` nodes using versions specified in the config file. A template config file and bitcoind aliases are in the subdirectory `templates/`
3029
- `integration_test/`: Integration tests that use `corepc-client` and `corepc-node` to test `corepc-types`.
31-
- `jsonrpc`: [`jsonrpc`](https://crates.io/crates/jsonrpc): Rudimentary support for sending JSONRPC 2.0 requests and receiving responses.
30+
- `jsonrpc/`: [`jsonrpc`](https://crates.io/crates/jsonrpc): Rudimentary support for sending JSONRPC 2.0 requests and receiving responses.
31+
- `node/`: [`corepc-node`](https://crates.io/crates/corepc-node): Runs `bitcoind` regtest nodes.
32+
- `types/`: [`corepc-types`](https://crates.io/crates/corepc-types): Rust types returned by the JSON-RPC API of Bitcoin Core.
33+
- `verify/`: Provides a tool to help verify the rest of the repository.
3234

3335
## Design
3436

0 commit comments

Comments
 (0)