Skip to content

Commit

Permalink
Fix doc test, add codecov and improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AurelienFT committed Dec 19, 2023
1 parent 28fa7b0 commit 1c0454d
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 10 deletions.
14 changes: 6 additions & 8 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,9 @@ jobs:
check_name: Test Results
github_token: ${{ secrets.GITHUB_TOKEN }}
files: results.xml
# Uncomment when open source
# - name: Upload to CodeCov
# uses: codecov/codecov-action@v1
# with:
# # required for private repositories:
# # token: ${{ secrets.CODECOV_TOKEN }}
# files: ./lcov.info
# fail_ci_if_error: true
- name: Upload to CodeCov
uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./lcov.info
fail_ci_if_error: true
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# BonsaiStorage

![example workflow](https://github.com/massalabs/bonsai-trie/actions/workflows/check_lint.yml/badge.svg) ![example workflow](https://github.com/massalabs/bonsai-trie/actions/workflows/test.yml/badge.svg) [![codecov](https://codecov.io/gh/massalabs/bonsai-trie/branch/main/graph/badge.svg?token=SLIHSUWHT2)](https://codecov.io/gh/massalabs/bonsai-trie)
![example workflow](https://github.com/massalabs/bonsai-trie/actions/workflows/check_lint.yml/badge.svg) ![example workflow](https://github.com/massalabs/bonsai-trie/actions/workflows/test.yml/badge.svg) [![codecov](https://codecov.io/gh/massalabs/bonsai-trie/branch/main/graph/badge.svg?token=SLIHSUWHT2)](https://codecov.io/gh/massalabs/bonsai-trie)


This crate provides a storage implementation based on the Bonsai Storage implemented by [Besu](https://hackmd.io/@kt2am/BktBblIL3).
It is a key/value storage that uses a Madara Merkle Trie to store the data.

## Build:

```
cargo build
```

## Doc and example:
```
cargo doc --open
```
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//!
//! Example usage with a RocksDB database:
//! ```
//! # use bonsai_storage::{
//! # use bonsai_trie::{
//! # databases::{RocksDB, create_rocks_db, RocksDBConfig},
//! # BonsaiStorageError,
//! # id::{BasicIdBuilder, BasicId},
Expand Down

0 comments on commit 1c0454d

Please sign in to comment.