diff --git a/Cargo.toml b/Cargo.toml index d351f66..f3ccbc0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,7 @@ license = "MIT OR Apache-2.0" description = "Persistence backend for bdk using redb" repository = "https://github.com/110CodingP/bdk_redb" readme = "README.md" +rust-version = "1.85.0" [dependencies] bdk_wallet = {version = "2.0.0", optional = true} diff --git a/README.md b/README.md index 14635eb..cdcaa14 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ # bdk_redb +[![Crate Info](https://img.shields.io/crates/v/bdk_redb.svg)](https://crates.io/crates/bdk_redb) +[![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) +[![Wallet API Docs](https://img.shields.io/badge/docs.rs-bdk_redb-green)](https://docs.rs/bdk_redb) +[![Coverage Status](https://coveralls.io/repos/github/110CodingP/bdk_redb/badge.svg)](https://coveralls.io/github/110CodingP/bdk_redb) +[![CI Status](https://github.com/110CodingP/bdk_redb/workflows/CI/badge.svg)](https://github.com/110CodingP/bdk_redb/actions?query=workflow:CI) +[![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) + ## About -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). +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). ## Status 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. There is currently one published crate in this repository: -- `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. +- [`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. ## Features 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). ## Minimum Supported Rust Version (MSRV) -The library maintains a MSRV of 1.85.0 due to dependency on [`redb`](https://docs.rs/redb/2.6.0/redb/index.html). +The library maintains a MSRV of 1.85.0 due to dependency on [`redb`](https://crates.io/crates/redb). ## License