docs: update README to deprecate the bdk lib

bitcoindevkit · Jan 8, 2025 · 8f4e487 · 8f4e487
1 parent 8081006
commit 8f4e487
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,12 @@
   </h4>
 </div>
 
+## !! 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
@@ -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.