Skip to content

Commit 137fdc8

Browse files
committed
docs: add rust-version, badges and update links
Modified the links to point to crates.io for better maintainability.
1 parent 048a6ea commit 137fdc8

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# bdk_redb
22

3+
[![Crate Info](https://img.shields.io/crates/v/bdk_redb.svg)](https://crates.io/crates/bdk_redb)
4+
[![Rustc Version 1.85.0+](https://img.shields.io/badge/rustc-1.85.0%2B-yellow.svg)](https://blog.rust-lang.org/2025/02/20/Rust-1.85.0.html)
5+
[![Wallet API Docs](https://img.shields.io/badge/docs.rs-bdk_redb-green)](https://docs.rs/bdk_redb)
6+
[![Coverage Status](https://coveralls.io/repos/github/110CodingP/bdk_redb/badge.svg)](https://coveralls.io/github/110CodingP/bdk_redb)
7+
[![CI Status](https://github.com/110CodingP/bdk_redb/workflows/CI/badge.svg)](https://github.com/110CodingP/bdk_redb/actions?query=workflow:CI)
8+
[![MIT or Apache-2.0 Licensed](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/110CodingP/bdk_redb/blob/master/LICENSE)
9+
310
## About
411

5-
The `bdk_redb` project provides a [`redb`](https://docs.rs/redb/2.6.0/redb/index.html) based persistence backend for [`bdk_wallet`](https://docs.rs/bdk_wallet/2.0.0/bdk_wallet/index.html) and [`bdk_chain`](https://docs.rs/bdk_chain/0.23.0/bdk_chain/index.html).
12+
The [`bdk_redb`](https://crates.io/crates/bdk_redb) project provides a [`redb`](https://crates.io/crates/redb) based persistence backend for [`bdk_wallet`](https://crates.io/crates/bdk_wallet) and [`bdk_chain`](https://crates.io/crates/bdk_chain).
613

714
## Status
815
The crate is currently EXPERIMENTAL. DO NOT use with MAINNET wallets.
@@ -11,13 +18,13 @@ The crate is currently EXPERIMENTAL. DO NOT use with MAINNET wallets.
1118

1219
There is currently one published crate in this repository:
1320

14-
- `bdk_redb`: Contains [`Store`](./src/lib.rs) type (that wraps around the [`redb`](https://docs.rs/redb/2.6.0/redb/index.html) database) along with persistence methods.
21+
- [`bdk_redb`](https://crates.io/crates/bdk_redb): Contains [`Store`](./src/lib.rs) type (that wraps around the [`redb`](https://crates.io/crates/redb) database) along with persistence methods.
1522

1623
## Features
1724
The crate has a default feature called `wallet` which provides methods on [`Store`](./src/lib.rs) to persist [`bdk_wallet::ChangeSet`](http://docs.rs/bdk_wallet/2.0.0/bdk_wallet/struct.ChangeSet.html) and [`bdk_wallet::WalletPersister`](https://docs.rs/bdk_wallet/2.0.0/bdk_wallet/trait.WalletPersister.html) implementation for [`Store`](./src/lib.rs).
1825

1926
## Minimum Supported Rust Version (MSRV)
20-
The library maintains a MSRV of 1.85.0 due to dependency on [`redb`](https://docs.rs/redb/2.6.0/redb/index.html).
27+
The library maintains a MSRV of 1.85.0 due to dependency on [`redb`](https://crates.io/crates/redb).
2128

2229
## License
2330

0 commit comments

Comments
 (0)