]> Untitled Git - bdk/commitdiff
docs(esplora): update README.md
authorvalued mammal <valuedmammal@protonmail.com>
Wed, 4 Dec 2024 14:12:54 +0000 (09:12 -0500)
committervalued mammal <valuedmammal@protonmail.com>
Wed, 4 Dec 2024 19:24:10 +0000 (14:24 -0500)
crates/esplora/README.md

index d06e386cda76a0d4baf667086d1604dc0699e36c..244deb20ffabe2c78b6af5ada568b1e9aaf5aedb 100644 (file)
@@ -10,17 +10,24 @@ The extension traits are primarily intended to satisfy [`SyncRequest`]s with [`s
 
 For blocking-only:
 ```toml
-bdk_esplora = { version = "0.3", features = ["blocking"] }
+bdk_esplora = { version = "0.19", features = ["blocking"] }
 ```
 
 For async-only:
 ```toml
-bdk_esplora = { version = "0.3", features = ["async"] }
+bdk_esplora = { version = "0.19", features = ["async"] }
 ```
 
 For async-only (with https):
+
+You can additionally specify to use either rustls or native-tls, e.g. `async-https-native`, and this applies to both async and blocking features.
+```toml
+bdk_esplora = { version = "0.19", features = ["async-https"] }
+```
+
+For async-only (with tokio):
 ```toml
-bdk_esplora = { version = "0.3", features = ["async-https"] }
+bdk_esplora = { version = "0.19", features = ["async", "tokio"] }
 ```
 
 To use the extension traits:
@@ -34,7 +41,7 @@ use bdk_esplora::EsploraExt;
 use bdk_esplora::EsploraAsyncExt;
 ```
 
-For full examples, refer to [`example-crates/wallet_esplora_blocking`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora_blocking) and [`example-crates/wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora_async).
+For full examples, refer to [`example_wallet_esplora_blocking`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/example_wallet_esplora_blocking) and [`example_wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/example_wallet_esplora_async).
 
 [`esplora-client`]: https://docs.rs/esplora-client/
 [`bdk_chain`]: https://docs.rs/bdk-chain/