From: Luis Schwab Date: Mon, 10 Mar 2025 15:40:11 +0000 (-0300) Subject: doc: remove 1.0 roadmap stuff and fix broken links X-Git-Tag: wallet-1.2.0~11^2 X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/enum.Wildcard.html?a=commitdiff_plain;h=609f12c2cf9f439d94211a663b27c62bd0c6a550;p=bdk doc: remove 1.0 roadmap stuff and fix broken links --- diff --git a/README.md b/README.md index f78350a9..7eee22e0 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,6 @@ The `bdk` libraries aims to provide well engineered and reviewed components for Bitcoin based applications. It is built upon the excellent [`rust-bitcoin`] and [`rust-miniscript`] crates. -> ⚠ 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. -> See for some background on this project: https://bitcoindevkit.org/blog/road-to-bdk-1/ (ignore the timeline 😁) -> For a release timeline see the [`BDK 1.0 project page`]. - ## Architecture The project is split up into several crates in the `/crates` directory: @@ -51,11 +47,10 @@ Fully working examples of how to use these components are in `/example-crates`: - [`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_wallet` library. - [`example_esplora`](./example-crates/example_esplora): A command line Bitcoin wallet application built on top of `example_cli` and the `esplora` crate. It shows the power of the bdk tools (`chain` + `file_store` + `esplora`), without depending on the main `bdk_wallet` library. - [`example_bitcoind_rpc_polling`](./example-crates/example_bitcoind_rpc_polling): A command line Bitcoin wallet application built on top of `example_cli` and the `bitcoind_rpc` crate. It shows the power of the bdk tools (`chain` + `file_store` + `bitcoind_rpc`), without depending on the main `bdk_wallet` library. -- [`wallet_esplora_blocking`](./example-crates/wallet_esplora_blocking): Uses the `Wallet` to sync and spend using the Esplora blocking interface. -- [`wallet_esplora_async`](./example-crates/wallet_esplora_async): Uses the `Wallet` to sync and spend using the Esplora asynchronous interface. -- [`wallet_electrum`](./example-crates/wallet_electrum): Uses the `Wallet` to sync and spend using Electrum. +- [`example_wallet_esplora_blocking`](./example-crates/example_wallet_esplora_blocking): Uses the `Wallet` to sync and spend using the Esplora blocking interface. +- [`example_wallet_esplora_async`](./example-crates/example_wallet_esplora_async): Uses the `Wallet` to sync and spend using the Esplora asynchronous interface. +- [`example_wallet_electrum`](./example-crates/example_wallet_electrum): Uses the `Wallet` to sync and spend using Electrum. -[`BDK 1.0 project page`]: https://github.com/orgs/bitcoindevkit/projects/14 [`rust-miniscript`]: https://github.com/rust-bitcoin/rust-miniscript [`rust-bitcoin`]: https://github.com/rust-bitcoin/rust-bitcoin [`esplora-client`]: https://docs.rs/esplora-client/