Skip to content

Commit f7c9bc5

Browse files
ValuedMammaloleonardolima
authored andcommitted
docs: update README.md with MSRV policy
- bdk_electrum: add MSRV section to README.md
1 parent 12eabd1 commit f7c9bc5

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,15 @@ Fully working examples of how to use these components are in `/example-crates`:
6363
[`bdk_chain`]: https://docs.rs/bdk-chain/
6464

6565
## Minimum Supported Rust Version (MSRV)
66-
This library should compile with any combination of features with Rust 1.63.0.
66+
The BDK library maintains a MSRV of 1.63.0. This includes the following crates
67+
68+
- `bdk_core`
69+
- `bdk_chain`
70+
- `bdk_bitcoind_rpc`.
71+
- `bdk_esplora`.
72+
- `bdk_wallet`.
73+
74+
The MSRV of `bdk_electrum` is 1.75.0.
6775

6876
To build with the MSRV you will need to pin dependencies as follows:
6977

@@ -80,7 +88,6 @@ cargo update -p indexmap --precise "2.5.0"
8088
cargo update -p security-framework-sys --precise "2.11.1"
8189
cargo update -p csv --precise "1.3.0"
8290
cargo update -p unicode-width --precise "0.1.13"
83-
cargo update -p rustls@0.23.21 --precise "0.23.19"
8491
```
8592

8693
## License

crates/electrum/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,13 @@
33
BDK Electrum extends [`electrum-client`] to update [`bdk_chain`] structures
44
from an Electrum server.
55

6+
## Minimum Supported Rust Version (MSRV)
7+
This crate has a MSRV of 1.75.0.
8+
9+
To build with MSRV you will need to pin dependencies as follows:
10+
```shell
11+
cargo update -p home --precise "0.5.9"
12+
```
13+
614
[`electrum-client`]: https://docs.rs/electrum-client/
715
[`bdk_chain`]: https://docs.rs/bdk-chain/

0 commit comments

Comments
 (0)