More documentation improvements

2023-03-10 13:40:27 +13:00
parent ae9b19d84c
commit 5dd4ce74cf
5 changed files with 50 additions and 6 deletions
--- a/crates/esplora/src/lib.rs
+++ b/crates/esplora/src/lib.rs
@@ -1,8 +1,4 @@
-//! This crate is used for updating structures of [`bdk_chain`] with data from an esplora server.
-//!
-//! The star of the show is the  [`EsploraExt::scan`] method which scans for relevant
-//! blockchain data (via esplora) and outputs a [`KeychainScan`](bdk_chain::keychain::KeychainScan).
-
+#![doc = include_str!("../README.md")]
 use bdk_chain::ConfirmationTime;
 use esplora_client::TxStatus;