Skip to content

Commit eefc1f9

Browse files
committed
chore: rename example-crates directory to examples
1 parent cddc0f2 commit eefc1f9

File tree

15 files changed

+13
-13
lines changed

15 files changed

+13
-13
lines changed

.github/workflows/cont_integration.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,5 +190,5 @@ jobs:
190190
- name: Rust Cache
191191
uses: Swatinem/rust-cache@v2.7.7
192192
- name: Build
193-
working-directory: example-crates/${{ matrix.example-dir }}
193+
working-directory: examples/${{ matrix.example-dir }}
194194
run: cargo build

Cargo.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ members = [
88
"crates/esplora",
99
"crates/bitcoind_rpc",
1010
"crates/testenv",
11-
"example-crates/example_cli",
12-
"example-crates/example_electrum",
13-
"example-crates/example_esplora",
14-
"example-crates/example_bitcoind_rpc_polling",
11+
"examples/example_cli",
12+
"examples/example_electrum",
13+
"examples/example_esplora",
14+
"examples/example_bitcoind_rpc_polling",
1515
]
1616

1717
[workspace.package]

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ The workspace in this repository contains several crates in the `/crates` direct
4141

4242
The [`bdk_wallet`] repository and crate contains a higher level `Wallet` type that depends on the above lower-level mechanism crates.
4343

44-
Fully working examples of how to use these components are in `/example-crates`:
44+
Fully working examples of how to use these components are in `/examples`:
4545

46-
- [`example_cli`](./example-crates/example_cli): Library used by the `example_*` crates. Provides utilities for syncing, showing the balance, generating addresses and creating transactions without using the bdk_wallet `Wallet`.
47-
- [`example_electrum`](./example-crates/example_electrum): A command line Bitcoin wallet application built on top of `example_cli` and the `electrum` crate. It shows the power of the bdk tools (`chain` + `file_store` + `electrum`), without depending on the main `bdk_wallet` library.
48-
- [`example_esplora`](./example-crates/example_esplora): A command line Bitcoin wallet application built on top of `example_cli` and the `esplora` crate. It shows the power of the bdk tools (`chain` + `file_store` + `esplora`), without depending on the main `bdk_wallet` library.
49-
- [`example_bitcoind_rpc_polling`](./example-crates/example_bitcoind_rpc_polling): A command line Bitcoin wallet application built on top of `example_cli` and the `bitcoind_rpc` crate. It shows the power of the bdk tools (`chain` + `file_store` + `bitcoind_rpc`), without depending on the main `bdk_wallet` library.
46+
- [`example_cli`](examples/example_cli): Library used by the `example_*` crates. Provides utilities for syncing, showing the balance, generating addresses and creating transactions without using the bdk_wallet `Wallet`.
47+
- [`example_electrum`](examples/example_electrum): A command line Bitcoin wallet application built on top of `example_cli` and the `electrum` crate. It shows the power of the bdk tools (`chain` + `file_store` + `electrum`), without depending on the main `bdk_wallet` library.
48+
- [`example_esplora`](examples/example_esplora): A command line Bitcoin wallet application built on top of `example_cli` and the `esplora` crate. It shows the power of the bdk tools (`chain` + `file_store` + `esplora`), without depending on the main `bdk_wallet` library.
49+
- [`example_bitcoind_rpc_polling`](examples/example_bitcoind_rpc_polling): A command line Bitcoin wallet application built on top of `example_cli` and the `bitcoind_rpc` crate. It shows the power of the bdk tools (`chain` + `file_store` + `bitcoind_rpc`), without depending on the main `bdk_wallet` library.
5050

5151
[`rust-miniscript`]: https://github.com/rust-bitcoin/rust-miniscript
5252
[`rust-bitcoin`]: https://github.com/rust-bitcoin/rust-bitcoin

crates/electrum/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
//!
1414
//! Refer to [`example_electrum`] for a complete example.
1515
//!
16-
//! [`example_electrum`]: https://github.com/bitcoindevkit/bdk/tree/master/example-crates/example_electrum
16+
//! [`example_electrum`]: https://github.com/bitcoindevkit/bdk/tree/master/examples/example_electrum
1717
//! [`SyncResponse`]: bdk_core::spk_client::SyncResponse
1818
//! [`FullScanResponse`]: bdk_core::spk_client::FullScanResponse
1919

crates/esplora/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ use bdk_esplora::EsploraExt;
4141
use bdk_esplora::EsploraAsyncExt;
4242
```
4343

44-
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).
44+
For full examples, refer to [`example_wallet_esplora_blocking`](https://github.com/bitcoindevkit/bdk/tree/master/examples/example_wallet_esplora_blocking) and [`example_wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/examples/example_wallet_esplora_async).
4545

4646
[`esplora-client`]: https://docs.rs/esplora-client/
4747
[`bdk_chain`]: https://docs.rs/bdk-chain/
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)