Update repo and electrsd readme#618
Merged
Merged
Conversation
Order the list alphabetically.
satsfy
reviewed
Jun 3, 2026
| - `bitreq/`: [`bitreq`](https://crates.io/crates/bitreq): Simple, minimal-dependency HTTP client, with optional features for proxies, async, and https. | ||
| - `client/`: [`corepc-client`](https://crates.io/crates/corepc-client): A blocking JSON-RPC client used to test `corepc-types`. | ||
| - `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/` | ||
| - `electrsd/`: [`electrsd`](https://crates.io/crates/electrsd): Utility to run a regtest [electrs](https://github.com/romanz/electrs/) process connected to a given [bitcoind](https://github.com/RCasatta/bitcoind) instance. |
Contributor
There was a problem hiding this comment.
Do we mean to point the user to RCasatta/bitcoind?
Because https://github.com/RCasatta/bitcoind resolves to https://github.com/rust-bitcoin/bitcoind, which points back to corepc. (tangent but rust-bitcoin/bitcoind points to corepc node, should point to corepc bitcoind).
Collaborator
Author
There was a problem hiding this comment.
It was a copy and paste from the electrsd readme. I have added a patch to update the link there and copied the changes to the repo readme.
The bitcoind link was stale. Update it and electrs to point to crates.io.
jamillambert
force-pushed
the
0602-repo-readme
branch
from
9d20486 to
f19ec0e
Compare
jamillambert
changed the title
tcharding
approved these changes
Jun 8, 2026
tcharding
reviewed
Jun 8, 2026
Comment on lines
-77
to
78
| * A free port is asked to the OS (a very low probability race condition is still possible) | ||
| * A free port is asked to the OS (a very low probability race condition is still possible) | ||
| * The process is killed when the struct goes out of scope no matter how the test finishes |
Member
There was a problem hiding this comment.
Unrelated whitespace change, merging anyways.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In repo readme move
bitcoindto the correct place alphabetically and add an entry forelectrsd.Update the links in the electrsd readme.