Skip to content

Commit cd5639f

Browse files
committed
doc: use crates.io version, put warning as comment
1 parent bbe60e3 commit cd5639f

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

src/lib.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
//! [`BDK`]: <https://github.com/bitcoindevkit>
66
//! [`redb`]: <https://github.com/cberner/redb>
77
//!
8-
//! <div class="warning">Warning: Descriptors in the following example are on a test network and
9-
//! only serve as an example. MAINNET funds sent to addresses controlled by these will be lost!
10-
//! </div>
118
//!
129
//! # Example
1310
//!
@@ -16,7 +13,7 @@
1613
//! ```toml
1714
//! [dependencies]
1815
//! anyhow = "1.0.98"
19-
//! bdk_redb = { git = "https://github.com/110CodingP/bdk_redb" }
16+
//! bdk_redb = { version = "0.1.0" }
2017
//! bdk_wallet = "2.0.0"
2118
//! tempfile = "3.20.0"
2219
//! ```
@@ -33,6 +30,8 @@
3330
//!
3431
//! use anyhow::Result;
3532
//!
33+
//! // Warning: Descriptors below are on a test network and only serve as an example.
34+
//! // MAINNET funds sent to addresses controlled by these descriptors will be LOST!
3635
//! const EXTERNAL_DESCRIPTOR: &str = "tr(tprv8ZgxMBicQKsPdrjwWCyXqqJ4YqcyG4DmKtjjsRt29v1PtD3r3PuFJAjWytzcvSTKnZAGAkPSmnrdnuHWxCAwy3i1iPhrtKAfXRH7dVCNGp6/86'/1'/0'/0/*)#g9xn7wf9";
3736
//! const INTERNAL_DESCRIPTOR: &str = "tr(tprv8ZgxMBicQKsPdrjwWCyXqqJ4YqcyG4DmKtjjsRt29v1PtD3r3PuFJAjWytzcvSTKnZAGAkPSmnrdnuHWxCAwy3i1iPhrtKAfXRH7dVCNGp6/86'/1'/0'/1/*)#e3rjrmea";
3837
//!

0 commit comments

Comments
 (0)