Skip to content

Commit 11ac26f

Browse files
docs: Update README.md
- Fixes the release timeline - Adds an explanation for the crates under `example-crates`
1 parent fb5cfa3 commit 11ac26f

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ It is built upon the excellent [`rust-bitcoin`] and [`rust-miniscript`] crates.
3333

3434
> ⚠ The Bitcoin Dev Kit developers are in the process of releasing a `v1.0` which is a fundamental re-write of how the library works.
3535
> See for some background on this project: https://bitcoindevkit.org/blog/road-to-bdk-1/ (ignore the timeline 😁)
36-
> For a release timeline see the [`bdk_core_staging`] repo where a lot of the component work is being done. The plan is that everything in the `bdk_core_staging` repo will be moved into the `crates` directory here.
36+
> For a release timeline see the [`BDK 1.0 project page`].
3737
3838
## Architecture
3939

@@ -45,13 +45,19 @@ The project is split up into several crates in the `/crates` directory:
4545
- [`esplora`](./crates/esplora): Extends the [`esplora-client`] crate with methods to fetch chain data from an esplora HTTP server in the form that [`bdk_chain`] and `Wallet` can consume.
4646
- [`electrum`](./crates/electrum): Extends the [`electrum-client`] crate with methods to fetch chain data from an electrum server in the form that [`bdk_chain`] and `Wallet` can consume.
4747

48-
Fully working examples of how to use these components are in `/example-crates`
48+
Fully working examples of how to use these components are in `/example-crates`:
49+
- [`example_cli`](./example-crates/example_cli): Library used by the `example_*` crates. Provides utilities for syncing, showing the balance, generating addresses and creating transactions without using the bdk `Wallet`.
50+
- [`example_electrum`](./example-crates/example_electrum): A command line Bitcoin wallet application built on top of `example_cli` and the `electrum` crate. It shows the power of the bdk tools (`chain` + `file_store` + `electrum`), without depending on the main `bdk` library.
51+
- [`wallet_esplora`](./example-crates/wallet_esplora): Uses the `Wallet` to sync and spend using the Esplora blocking interface.
52+
- [`wallet_esplora_async`](./example-crates/wallet_esplora_async): Uses the `Wallet` to sync and spend using the Esplora asynchronous interface.
53+
- [`wallet_electrum`](./example-crates/wallet_electrum): Uses the `Wallet` to sync and spend using Electrum.
4954

50-
[`bdk_core_staging`]: https://github.com/LLFourn/bdk_core_staging
55+
[`BDK 1.0 project page`]: https://github.com/orgs/bitcoindevkit/projects/14
5156
[`rust-miniscript`]: https://github.com/rust-bitcoin/rust-miniscript
5257
[`rust-bitcoin`]: https://github.com/rust-bitcoin/rust-bitcoin
53-
[`esplora-client`]: https://docs.rs/esplora-client/0.3.0/esplora_client/
54-
[`electrum-client`]: https://docs.rs/electrum-client/0.13.0/electrum_client/
58+
[`esplora-client`]: https://docs.rs/esplora-client/
59+
[`electrum-client`]: https://docs.rs/electrum-client/
60+
[`bdk_chain`]: https://docs.rs/bdk-chain/
5561

5662
## Minimum Supported Rust Version (MSRV)
5763
This library should compile with any combination of features with Rust 1.57.0.

0 commit comments

Comments
 (0)