Skip to content

Commit 874a28c

Browse files
committed
Merge #219: Redocument everything
4208540 doc(lib): redocument lib.rs (Luis Schwab) 93d3a6a doc(client): redocument async and blocking clients (Luis Schwab) 0236475 doc(api): redocument API types (Luis Schwab) Pull request description: Closes #208 ## Changelog ``` - Re-document the whole crate ``` ACKs for top commit: oleonardolima: ACK 4208540 Tree-SHA512: 3e3245d95721ac094156f4370d2ee1caa8da78d60a8574722502ca7fed47326be2019943a65c3c02dd68f8da9da34eb199dd16022d7f8a751d134a195a3ac0cf
2 parents 4ca4dfc + 4208540 commit 874a28c

6 files changed

Lines changed: 758 additions & 422 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ license = "MIT OR Apache-2.0"
1010
homepage = "https://github.com/bitcoindevkit/rust-esplora-client"
1111
repository = "https://github.com/bitcoindevkit/rust-esplora-client"
1212
documentation = "https://docs.rs/esplora-client/"
13-
description = "Bitcoin Esplora API client library. Supports plaintext, TLS and Onion servers. Blocking or async."
13+
description = "Asynchronous and blocking clients and types for interacting with Esplora servers over HTTP"
1414
keywords = ["bitcoin", "esplora"]
1515
readme = "README.md"
1616
rust-version = "1.75.0" # MSRV

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# rust-esplora-client
22

3-
Bitcoin Esplora API client library. Supports plaintext, TLS and Onion servers. Blocking or async.
4-
53
<p>
64
<a href="https://crates.io/crates/esplora-client"><img src="https://img.shields.io/crates/v/esplora-client.svg"/></a>
75
<a href="https://docs.rs/esplora-client"><img src="https://img.shields.io/badge/docs.rs-esplora--client-blue"/></a>
@@ -10,6 +8,8 @@ Bitcoin Esplora API client library. Supports plaintext, TLS and Onion servers. B
108
<a href="https://github.com/bitcoindevkit/rust-esplora-client/actions/workflows/rust.yml"><img src="https://github.com/bitcoindevkit/rust-esplora-client/actions/workflows/rust.yml/badge.svg"></a>
119
</p>
1210

11+
Asynchronous and blocking clients and types for interacting with Esplora servers over HTTP.
12+
1313
## Developing
1414

1515
This project uses [`just`](https://github.com/casey/just) for command running, and

0 commit comments

Comments
 (0)