]> Untitled Git - bdk/commitdiff
docs: update `README.md` with MSRV policy
authorvalued mammal <valuedmammal@protonmail.com>
Fri, 17 Jan 2025 18:12:36 +0000 (13:12 -0500)
committerLeonardo Lima <oleonardolima@users.noreply.github.com>
Tue, 21 Jan 2025 19:51:18 +0000 (16:51 -0300)
- bdk_electrum: add MSRV section to README.md

README.md
crates/electrum/README.md

index cdc3df7267845ae2b1c813b844e5b901cc3dcc9d..67a65d40c01ca86b0fa5fa57ef2d75393e27c3cf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -63,7 +63,15 @@ Fully working examples of how to use these components are in `/example-crates`:
 [`bdk_chain`]: https://docs.rs/bdk-chain/
 
 ## Minimum Supported Rust Version (MSRV)
-This library should compile with any combination of features with Rust 1.63.0.
+The BDK library maintains a MSRV of 1.63.0. This includes the following crates 
+
+- `bdk_core`
+- `bdk_chain`
+- `bdk_bitcoind_rpc`.
+- `bdk_esplora`.
+- `bdk_wallet`.
+
+The MSRV of `bdk_electrum` is 1.75.0.
 
 To build with the MSRV you will need to pin dependencies as follows:
 
@@ -80,7 +88,6 @@ cargo update -p indexmap --precise "2.5.0"
 cargo update -p security-framework-sys --precise "2.11.1"
 cargo update -p csv --precise "1.3.0"
 cargo update -p unicode-width --precise "0.1.13"
-cargo update -p rustls@0.23.21 --precise "0.23.19"
 ```
 
 ## License
index 1bafe04eb4b888e838891111091714f4299f7166..efe7109cbeb7aaac5c06e1715d740ff24734068e 100644 (file)
@@ -3,5 +3,13 @@
 BDK Electrum extends [`electrum-client`] to update [`bdk_chain`] structures
 from an Electrum server.
 
+## Minimum Supported Rust Version (MSRV)
+This crate has a MSRV of 1.75.0.
+
+To build with MSRV you will need to pin dependencies as follows:
+```shell
+cargo update -p home --precise "0.5.9"
+```
+
 [`electrum-client`]: https://docs.rs/electrum-client/
 [`bdk_chain`]: https://docs.rs/bdk-chain/