Skip to content

Commit

Permalink
slh-dsa: improve README.md (#826)
Browse files Browse the repository at this point in the history
  • Loading branch information
tarcieri authored May 28, 2024
1 parent b5dc506 commit 71934e7
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions slh-dsa/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# 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

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

Expand All @@ -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

0 comments on commit 71934e7

Please sign in to comment.