Skip to content

Commit

Permalink
Add badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
praveenperera committed Jul 28, 2024
1 parent 62992ed commit acb72c7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# bip329
# BIP329

<p>
<a href="https://crates.io/crates/bip329"><img alt="Crate Info" src="https://img.shields.io/crates/v/bip329.svg"/></a>
<a href="https://github.com/bitcoinppl/bip329/blob/master/LICENSE"><img alt="Apache-2.0 Licensed" src="https://img.shields.io/badge/Apache--2.0-blue.svg"/></a>
<a href="https://github.com/bitcoinppl/bip329/actions?query=workflow%3ACI"><img alt="CI Status" src="https://github.com/bitcoinppl/bip329/workflows/CI/badge.svg"></a>
<a href="https://coveralls.io/github/bitcoinppl/bdk?branch=master"><img src="https://coveralls.io/repos/github/bitcoinppl/bip329/badge.svg?branch=master"/></a>
<a href="https://docs.rs/bip329"><img alt="Docs" src="https://img.shields.io/badge/docs.rs-green"/></a>
</p>

<!-- cargo-rdme start -->

Expand All @@ -15,13 +23,15 @@ The [`Labels`](https://docs.rs/bip329/latest/bip329/struct.Labels.html) struct c
The `Labels` struct can be imported from a JSONL file.

#### Example Import:

```rust
use bip329::Labels;

let labels = Labels::try_from_file("tests/data/labels.jsonl").unwrap();
```

#### Example Export:

```rust
use bip329::Labels;

Expand All @@ -35,6 +45,7 @@ let jsonl = labels.export().unwrap();
You can encrypt and decrypt the `Labels` into/from the [`encryption::EncryptedLabels`](https://docs.rs/bip329/latest/bip329/encryption/struct.EncryptedLabels.html) struct using the `encryption` feature.

#### Example encryption:

```rust
use bip329::{Labels, encryption::EncryptedLabels};

Expand Down

0 comments on commit acb72c7

Please sign in to comment.