From e52c91115a563c4a3c55e2e1d112e35ec3504171 Mon Sep 17 00:00:00 2001 From: Steve Myers Date: Mon, 6 Jan 2025 15:13:55 -0600 Subject: [PATCH] docs: update README to deprecate the bdk lib --- README.md | 6 ++++++ src/lib.rs | 11 +++++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 446166f3..106610d4 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,12 @@ +## !! DEPRECATED !! + +The [bdk](https://crates.io/crates/bdk) library is now deprecated and replaced by [bdk_wallet](https://crates.io/crates/bdk_wallet). All projects should migrate to [bdk_wallet 1.0.0](https://crates.io/crates/bdk_wallet/1.0.0) or newer as soon as possible. For migration instructions see the ["Book of BDK"](https://bitcoindevkit.github.io/book-of-bdk/) chapter on ["Migrating from 0.x"](https://bitcoindevkit.github.io/book-of-bdk/getting-started/migrating/). + +The BDK team will continue to publish `bdk` `0.30.x` bug fix releases as needed, but only for a limited time. + ## About The `bdk` library aims to be the core building block for Bitcoin wallets of any kind. diff --git a/src/lib.rs b/src/lib.rs index 93179932..80481b4a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -21,6 +21,17 @@ //! A modern, lightweight, descriptor-based wallet library written in Rust. //! +//! ## !! DEPRECATED !! +//! +//! The [bdk](https://crates.io/crates/bdk) library is now deprecated and replaced by +//! [bdk_wallet](https://crates.io/crates/bdk_wallet). All projects should migrate to +//! [bdk_wallet 1.0.0](https://crates.io/crates/bdk_wallet/1.0.0) or newer as soon as possible. For +//! migration instructions see the ["Book of BDK"](https://bitcoindevkit.github.io/book-of-bdk/) +//! chapter on ["Migrating from 0.x"](https://bitcoindevkit.github.io/book-of-bdk/getting-started/migrating/). +//! +//! The BDK team will continue to publish `bdk` `0.30.x` bug fix releases as needed, but only for a +//! limited time. +//! //! # About //! //! The BDK library aims to be the core building block for Bitcoin wallets of any kind. -- 2.49.0