From 492e8396a1144407aa0d74c6dbc9c5c7c80d926e Mon Sep 17 00:00:00 2001 From: Sergey Minaev Date: Wed, 20 Dec 2023 00:36:53 +0500 Subject: [PATCH] Release 0.0.3. - clean-up readme Signed-off-by: Sergey Minaev --- Cargo.toml | 3 ++- README.md | 17 ++--------------- 2 files changed, 4 insertions(+), 16 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 6005262..1ee853a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,13 @@ [package] name = "sd-jwt-rs" -version = "0.0.2" +version = "0.0.3" edition = "2021" license = "Apache-2.0 OR MIT" description = "Rust reference implementation of the IETF SD-JWT specification (v6)." rust-version = "1.74.0" authors = ["Sergey Minaev "] repository = "https://github.com/openwallet-foundation-labs/sd-jwt-rust" +homepage = "https://github.com/openwallet-foundation-labs/sd-jwt-rust" [dependencies] base64 = "0.21" diff --git a/README.md b/README.md index bc421c4..110ef08 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,6 @@ Supported version: 6. Note: while the project is started as a reference implementation, it is intended to be evolved to a production-ready, high-performance implementations in the long-run. -## Usage -Include the crate in the `[dependencies]` section of your `Cargo.toml`: -``` -sd-jwt-payload = "0.0.1" -``` - ## API Note: the current version of the crate is 0.0.x, so the API should be considered as experimental. Proposals about API improvements are highly appreciated. @@ -46,12 +40,11 @@ cargo test ``` ### Interoperability testing tool -TBD +Coming soon (planned for v0.0.4) ## External Dependencies -Dual license (MIT/Apache 2.0) -dependencies: [base64](https://crates.io/crates/base64), [lazy_static](https://crates.io/crates/lazy_static) [log](https://crates.io/crates/log), [serde](https://crates.io/crates/serde), [serde_json](https://crates.io/crates/serde_json), [sha2](https://crates.io/crates/sha2), [rand](https://crates.io/crates/rand), [hmac](https://crates.io/crates/hmac), [thiserror](https://crates.io/crates/thiserror). +Dual license (MIT/Apache 2.0) dependencies: [base64](https://crates.io/crates/base64), [lazy_static](https://crates.io/crates/lazy_static) [log](https://crates.io/crates/log), [serde](https://crates.io/crates/serde), [serde_json](https://crates.io/crates/serde_json), [sha2](https://crates.io/crates/sha2), [rand](https://crates.io/crates/rand), [hmac](https://crates.io/crates/hmac), [thiserror](https://crates.io/crates/thiserror). MIT license dependencies: [jsonwebtoken](https://crates.io/crates/jsonwebtoken), [strum](https://crates.io/crates/strum) Note: the list of dependencies may be changed in the future. @@ -60,9 +53,3 @@ Note: the list of dependencies may be changed in the future. - Sergey Minaev ([Github](https://github.com/jovfer)) - DSR Corporation Decentralized Systems Team ([Github](https://github.com/orgs/DSRCorporation/teams/decentralized-systems)) - -## To Be Completed by Maintainers -- [x] Create MAINTAINERS.md file using the [format documented on the TAC site](https://tac.openwallet.foundation/governance/maintainers-file-content/). -- [ ] Create a CONTRIBUTING.md file that documents steps for contributing to the project -- [X] Create a CODEOWNERS file -- [X] Update the README.md file as necessary \ No newline at end of file