Skip to content

Docs: Update README for library#28

Open
tvpeter wants to merge 2 commits intobitcoindevkit:masterfrom
tvpeter:docs/update-readme
Open

Docs: Update README for library#28
tvpeter wants to merge 2 commits intobitcoindevkit:masterfrom
tvpeter:docs/update-readme

Conversation

@tvpeter
Copy link
Collaborator

@tvpeter tvpeter commented Feb 3, 2026

Description

This PR updates the Readme for the library.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

Copy link
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cACK

Comment on lines +3 to +5
A minimal, experimental Bitcoin Core RPC client designed specifically for the Bitcoin Dev Kit (BDK). Unlike generic RPC wrappers,
`bdk-bitcoind-client` focuses on high-performance data emission and strict type safety, with built-in support for multiple Bitcoin
Core versions (v28.0 through v30.0+).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unlike generic RPC wrappers, bdk-bitcoind-client focuses on high-performance data emission

This sounds vague. You could just say it's a client that retrieves blockchain data from bitcoind over JSON-RPC.

A minimal, experimental Bitcoin Core RPC client

"experimental", though I expect there will be some BDK users who'd eventually like to use it in production as well.

@ValuedMammal
Copy link
Collaborator

This looks great.

In 699fafc - docs: Update README for the library

For code blocks you should include the language to enable syntax highlighting. Note that for toml files comments are denoted with #.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants