Skip to content

Commit a3d6840

Browse files
committed
Update README
1 parent 9397251 commit a3d6840

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,26 @@ If you require a JSON RPC client in production software it is expected you write
1313
use the `corepc-types` crate in your dependency graph. Feel free to copy/steal/plagiarise or
1414
otherwise enjoy yourself with anything in this repository - no attribution required.
1515

16-
**Please do not use `corepc` in production and raise bugs, issues, or feature requests.**
16+
## Contributing
17+
18+
PRs, feature requests, and bug reports against `corepc-types` most welcome and appreciated.
19+
20+
PRs, feature requests, and bug reports against the other crates welcome if you are using them for
21+
integration testing.
22+
23+
**Please do not use `corepc-client` in production and raise bugs, issues, or feature requests.**
1724

1825
## Crate/directory listing
1926

2027
- `types/`: [`corepc-types`](https://crates.io/crates/corepc-types): Rust types returned by the JSON-RPC API of Bitcoin Core.
21-
- `bitcoind/`: [`corepc-node`](https://crates.io/crates/corepc-node): Runs `bitcoind` regtest nodes.
28+
- `node/`: [`corepc-node`](https://crates.io/crates/corepc-node): Runs `bitcoind` regtest nodes.
2229
- `client/`: [`corepc-client`](https://crates.io/crates/corepc-client): A blocking JSON-RPC client used to test `corepc-types`.
23-
- `integration_test/`: Integration tests that use `corepc` and `corepc-node` to test `corepc-types`.
30+
- `integration_test/`: Integration tests that use `corepc-client` and `corepc-node` to test `corepc-types`.
31+
2432

33+
## Design
2534

26-
## `corepc-types` Design
35+
This repository is a bit oddly designed. It was done so very intentionally.
2736

2837
## Original code
2938

0 commit comments

Comments
 (0)