From 71934e74a887f383a08ae8bc5c70a63f033952b3 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Tue, 28 May 2024 14:07:34 -0600 Subject: [PATCH] slh-dsa: improve README.md (#826) --- slh-dsa/README.md | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/slh-dsa/README.md b/slh-dsa/README.md index 8e2d13bc..e6241d07 100644 --- a/slh-dsa/README.md +++ b/slh-dsa/README.md @@ -1,8 +1,15 @@ -# SLH-DSA +# [RustCrypto]: SLH-DSA + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![MSRV][rustc-image] +[![Project Chat][chat-image]][chat-link] Pure Rust implementation of the SLH-DSA (aka SPHINCS+) signature scheme. -Implemented based on the [FIPS-205 Inital Public Draft](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.205.ipd.pdf) +Implemented based on the [FIPS-205 Inital Public Draft]. ## ⚠️ Security Warning @@ -10,9 +17,12 @@ The implementation contained in this crate has never been independently audited! USE AT YOUR OWN RISK! -## Minimum Supported Version +## Minimum Supported Rust Version + +This crate requires **Rust 1.75** at a minimum. -This crate has only been tested with Rust 1.75+ +We may change the MSRV in the future, but it will be accompanied by a minor +version bump. ## License @@ -28,3 +38,19 @@ at your option. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. + +[crate-image]: https://buildstats.info/crate/slh-dsa +[crate-link]: https://crates.io/crates/slh-dsa +[docs-image]: https://docs.rs/slh-dsa/badge.svg +[docs-link]: https://docs.rs/slh-dsa/ +[build-image]: https://github.com/RustCrypto/signatures/actions/workflows/slh-dsa.yml/badge.svg +[build-link]: https://github.com/RustCrypto/signatures/actions/workflows/slh-dsa.yml +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.75+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260048-signatures + +[//]: # (links) + +[RustCrypto]: https://github.com/RustCrypto +[FIPS-205 Inital Public Draft]: https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.205.ipd.pdf