diff --git a/README.md b/README.md index 47a21a5..0705142 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# bip329 +# BIP329 + +
@@ -15,6 +23,7 @@ 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; @@ -22,6 +31,7 @@ let labels = Labels::try_from_file("tests/data/labels.jsonl").unwrap(); ``` #### Example Export: + ```rust use bip329::Labels; @@ -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};