Skip to content

Commit

Permalink
docs: update README.md with MSRV policy
Browse files Browse the repository at this point in the history
- bdk_electrum: add MSRV section to README.md
  • Loading branch information
ValuedMammal authored and oleonardolima committed Jan 21, 2025
1 parent eae8a9b commit ee71bd3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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 [email protected] --precise "0.23.19"
```

## License
Expand Down
8 changes: 8 additions & 0 deletions crates/electrum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/

0 comments on commit ee71bd3

Please sign in to comment.