diff --git a/CHANGELOG.md b/CHANGELOG.md index f38f8b6..92bb84e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ # Changelog -## [Unreleased] +## [0.1.1] - 2023-07-28 + +- Documentation formatting + +## [0.1.0] - 2023-07-28 - Import and export BIP329 labels from and to JSONL files - Basic encryption and decryption support diff --git a/Cargo.lock b/Cargo.lock index 049b9b7..fca8730 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -96,7 +96,7 @@ dependencies = [ [[package]] name = "bip329" -version = "0.1.0" +version = "0.1.1" dependencies = [ "age", "hex", diff --git a/Cargo.toml b/Cargo.toml index 1e11e60..0d442c9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] authors = ["Praveen Perera "] name = "bip329" -version = "0.1.0" +version = "0.1.1" edition = "2021" description = "A library for working with BIP329 labels" license = "Apache-2.0" diff --git a/README.md b/README.md index 640469c..2b43319 100644 --- a/README.md +++ b/README.md @@ -11,18 +11,13 @@ A library for working with [BIP329 labels](https://github.com/bitcoin/bips/blob/master/bip-00329.mediawiki). -This library provides a way to work with BIP329 labels in a Rust program. - -The main data structure is the [`Labels`](https://docs.rs/bip329/latest/bip329/struct.Labels.html) struct, which is a list of [`Label`](https://docs.rs/bip329/latest/bip329/enum.Label.html) structs. - -The [`Label`](https://docs.rs/bip329/latest/bip329/enum.Label.html) enum is a discriminated union of all the different types of labels. - -The [`Labels`](https://docs.rs/bip329/latest/bip329/struct.Labels.html) struct can be exported to a JSONL file. - -The `Labels` struct can be imported from a JSONL file. +- The main data structure is the [`Labels`](https://docs.rs/bip329/latest/bip329/struct.Labels.html) struct, which is a list of [`Label`](https://docs.rs/bip329/latest/bip329/enum.Label.html) structs. +- The [`Label`](https://docs.rs/bip329/latest/bip329/enum.Label.html) enum containing all the different types of labels. +- The [`Labels`](https://docs.rs/bip329/latest/bip329/struct.Labels.html) struct can be imported/exported to/from a JSONL file. +- Supports encryption and decryption using the [`encryption`](https://docs.rs/bip329/latest/bip329/encryption/) module. +- Supports the [`uniffi`](https://github.com/mozilla/uniffi-rs) feature, for easy integration with other languages. #### Example Import: - ```rust use bip329::Labels; @@ -30,7 +25,6 @@ let labels = Labels::try_from_file("tests/data/labels.jsonl").unwrap(); ``` #### Example Export: - ```rust use bip329::Labels; @@ -41,10 +35,7 @@ let labels = Labels::try_from_file("tests/data/labels.jsonl").unwrap(); 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}; diff --git a/src/lib.rs b/src/lib.rs index 803cc2e..7b1c875 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,14 +1,10 @@ //! A library for working with [BIP329 labels](https://github.com/bitcoin/bips/blob/master/bip-00329.mediawiki). //! -//! This library provides a way to work with BIP329 labels in a Rust program. -//! -//! The main data structure is the [`Labels`](crate::Labels) struct, which is a list of [`Label`](crate::Label) structs. -//! -//! The [`Label`](crate::Label) enum is a discriminated union of all the different types of labels. -//! -//! The [`Labels`](crate::Labels) struct can be exported to a JSONL file. -//! -//! The `Labels` struct can be imported from a JSONL file. +//! - The main data structure is the [`Labels`](crate::Labels) struct, which is a list of [`Label`](crate::Label) structs. +//! - The [`Label`](crate::Label) enum containing all the different types of labels. +//! - The [`Labels`](crate::Labels) struct can be imported/exported to/from a JSONL file. +//! - Supports encryption and decryption using the [`encryption`](crate::encryption) module. +//! - Supports the [`uniffi`](https://github.com/mozilla/uniffi-rs) feature, for easy integration with other languages. //! //! ### Example Import: //! ```rust @@ -28,8 +24,6 @@ //! let jsonl = labels.export().unwrap(); //! ``` //! -//! You can encrypt and decrypt the `Labels` into/from the [`encryption::EncryptedLabels`](crate::encryption::EncryptedLabels) struct using the `encryption` feature. -//! //! ### Example encryption: //! ```rust //! use bip329::{Labels, encryption::EncryptedLabels};