chore(doc): update README

Updates the README with pointers to `cargo-rbmt` and new recipes.

Also adds badges and fixes a bunch of nits.

Author: luisschwab

README.md

@@ -1,77 +1,127 @@
 # bdk-bitcoind-client
 
-A minimal Bitcoin Core RPC client designed specifically for the Bitcoin Dev Kit (BDK). It retrieves blockchain data from `bitcoind` over JSON-RPC and supports multiple versions of Bitcoin Core (v28.0 through v30.0+).
+<p>
+    <!-- <a href="https://crates.io/crates/bdk-bitcoind-client"><img src="https://img.shields.io/crates/v/bdk-bitcoind-client.svg"/></a> -->
+    <!-- <a href="https://docs.rs/bdk-bitcoind-client"><img src="https://img.shields.io/badge/docs.rs-bdk-bitcoind-client-orange"/></a> -->
+    <a href="https://blog.rust-lang.org/2025/02/20/Rust-1.85.0/"><img src="https://img.shields.io/badge/rustc-1.85.0%2B-orange.svg"/></a>
+    <a href="https://github.com/bitcoindevkit/bdk-bitcoind-client/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT%2FApache--2.0-red.svg"/></a>
+    <a href="https://github.com/bitcoindevkit/bdk-bitcoind-client/actions/workflows/cont_integration.yml"><img src="https://github.com/bitcoindevkit/bdk-bitcoind-client/actions/workflows/cont_integration.yml/badge.svg"></a>
+</p>
 
-### Features 
+A minimal `bitcoind` RPC client custom built for [BDK](https://github.com/bitcoindevkit/bdk).
 
-- _Version Pinning_: Explicit support for different Bitcoin Core RPC schemas via feature flags (28_0, 29_0, 30_0).
-- _Minimal Dependencies_: Uses bitreq_http for a lightweight HTTP transport by default.
-- _Wallet-Agnostic_: Focused on blockchain data emission (blocks, headers, mempool) rather than wallet management.
-- _Robust Error Handling_: Specific error variants for RPC failures, deserialization issues, and transport timeouts.
+## Features
 
-### Installation
+- **Multiple Bitcoin Core Version Support**: implements support for multiple Bitcoin Core versions in the backend:
+  - Bitcoin Core v30.0
+  - Bitcoin Core v29.0
+  - Bitcoin Core v28.0
+
+- **Minimal Dependencies**: by default, the minimal `bitreq_http` is used as the HTTP transport.
+
+- **Separation of Concerns**: focused on emitting generic data structures, such as blocks,
+headers and mempool. Interpreting this data is left to wallets that use this crate as a chain-source.
+
+- **Robust Error Handling**: implements specifc error variants for RPC, deserialization and transport errors.
+
+## Usage
+
+Add this to your `Cargo.toml` manifest to use this crate with
+the latest Bitcoin Core version (currently v30.0) as the backend:
 
-Add this to your `Cargo.toml`:
 ```toml
-# For the latest Bitcoin Core (v30.0+) 
 bdk-bitcoind-client = { version = "0.1.0" }
+```
 
-# OR for older nodes (e.g., v28.x) 
+Alternatively, add this to your `Cargo.toml` manifest to use this crate
+with a specific Bitcoin Core version as the backend (v28.0 or v29.0):
+
+```toml
+# Bitcoin Core v29.0
+bdk-bitcoind-client = { version = "0.1.0", default-features = false, features = ["29_0"] }
+
+# Bitcoin Core v28.0
 bdk-bitcoind-client = { version = "0.1.0", default-features = false, features = ["28_0"] }
 ```
 
-### Quick Start
+## Quick Start
 
 ```rust
 use bdk_bitcoind_client::{Auth, Client};
 use std::path::PathBuf;
 fn main() -> anyhow::Result<()> {
-    // 1. Setup authentication (Cookie file is recommended for security)
+    // Define how to authenticate with `bitcoind` (Cookie File or User/Pass)
     let auth = Auth::CookieFile(PathBuf::from("/path/to/regtest/.cookie"));
+    let auth = Auth::UserPass("user".to_string(), "pass".to_string());
 
-    // 2. Initialize the client
+    // Instantiate a JSON-RCP `Client`
     let client = Client::with_auth("http://127.0.0.1:18443", auth)?;
 
-    // 3. Query the blockchain
+    // Perform blockchain queries to `bitcoind` using the `Client`
     let block_count = client.get_block_count()?;
     let best_hash = client.get_block_hash(block_count)?;
-    
-    // 4. Get verbose headers (handles schema differences automatically)
     let header = client.get_block_header_verbose(&best_hash)?;
-    
+
+    println!("Block Count: {}", block_count);
+    println!("Best Block Hash: {}", best_hash);
     println!("Chain tip: {} at height {}", header.hash, header.height);
 
     Ok(())
 }
 ```
 
-### Version Compatibility
+## Bitcoin Core Version Compatibility
 
-Bitcoin Core often changes its JSON-RPC response fields (e.g., adding the target field in `v29/v30`). This client manages these differences through compile-time features.
+Bitcoin Core often changes its JSON-RPC schema, such as the addition of the `target`
+and `difficulty` fields in the `getmininginfo` RPC on Bitcoin Core v29.0 and newer.
 
-| Feature           | Bitcoin Core Version  | Notes                                        |
-| ----------------- | --------------------- | -------------------------------------------- | 
-| 30_0 (default)    | v30.x and newer       | Supports latest target and difficulty fields.|
-| 29_0              | v29.x                 | Aligned with v29 schema. |
-| 28_0             | v28.x and older        | Omits newer fields |
+This crate manages this via compile-time feature flags:
 
+| Feature Flag     | Bitcoin Core Version | Notes                                                        |
+| ---------------- | -------------------- | ------------------------------------------------------------ |
+| `30_0` (default) | v30.x                |                                                              |
+| `29_0`           | v29.x                | Supports `target` and `difficulty` fields on `getmininginfo` |
+| `28_0`           | v28.x and older      | Omits newer fields                                           |
 
-### Development and Testing
-To run tests against a specific Bitcoin Core version, use the corresponding feature flag:
 
-```
-cargo test --no-default-features --features 28_0
-```
+## Developing
 
-### Minimum Supported Rust Version (MSRV)
+This project uses [`cargo-rbmt`](https://github.com/rust-bitcoin/rust-bitcoin-maintainer-tools/tree/master/cargo-rbmt)
+to manage everything related to `cargo`, such as formatting, linting, testing and CI. To install it, run:
 
-The library maintain a MSRV of 1.85.0.
+```console
+~$ cargo install cargo-rbmt
+```
+
+A `justfile` is provided for convenient command-running. You must have
+[`just`](https://github.com/casey/just?tab=readme-ov-file#installation) installed.
+
+Run `just` to see available commands:
+
+```console
+> bdk-bitcoind-client
+> An experimental `bitcoind` RPC client for BDK
+
+Available recipes:
+    build                # Build the `bdk-bitcoind-client` [alias: b]
+    check                # Check code formatting, compilation, and linting [alias: c]
+    check-features       # Check that all feature combinations compile [alias: cf]
+    check-sigs           # Checks whether all commits in this branch are PGP-signed [alias: cs]
+    doc                  # Generate documentation [alias: d]
+    doc-open             # Generate and open documetation [alias: do]
+    fmt                  # Format code [alias: f]
+    lock                 # Regenerate `Cargo-recent.lock` and `Cargo-minimal.lock` [alias: l]
+    msrv                 # Verify the library builds with the MSRV toolchain (1.85.0) [alias: m]
+    pre-push             # Run pre-push suite: lock, check-sigs, fmt, check, test, and msrv [alias: p]
+    test                 # Run all tests on the workspace with all features [alias: t]
+    test-version VERSION # Run tests against a specific Bitcoin Core version: 30_0, 29_0, 28_0 [alias: tv]
+```
 
-## Just
+## Minimum Supported Rust Version (MSRV)
 
-This project has a [`justfile`](/justfile) for easy command running. You must have [`just`](https://github.com/casey/just) installed.
+This library should compile with any combination of features on Rust 1.85.0.
 
-To see a list of available recipes: `just`
+To build with the MSRV toolchain, copy `Cargo-minimal.lock` to `Cargo.lock`.
 
 ## License