From 6cc05c4184a8e44b84a81670fedb816f1e873d90 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Sun, 8 Apr 2018 21:43:40 +0200 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3d00a40..c5b955c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# merkle_sigs.rs -🎄🖋 A Rust implementation of Merkle signing +# merkle_sigs + +[![Build Status](https://travis-ci.org/SpinResearch/merkle_sigs.rs.svg?branch=master&style=flat)](https://travis-ci.org/SpinResearch/merkle_sigs.rs) +[![Available on Crates.io as merkle_sigs](https://img.shields.io/crates/v/merkle_sigs.svg)](https://crates.io/crates/merkle_sigs) +![License](https://img.shields.io/badge/license-bsd3-brightgreen.svg?style=flat) + +*merkle_sigs* is a Rust implementation of a [Merkle signing scheme](https://blog.cryptographyengineering.com/2018/04/07/hash-based-signatures-an-illustrated-primer/). + +## Documentation + +Documentation is [available](https://spinresearch.github.io/merkle_sigs.rs/merkle_sigs/). + +## Bug Reporting + +Please report bugs either as pull requests or as issues in [the issue +tracker](https://github.com/SpinResearch/merkle_sigs.rs). *merkle_sigs* has a +**full disclosure** vulnerability policy. **Please do NOT attempt to report +any security vulnerability in this code privately to anybody.** + +## License + +See [LICENSE](LICENSE).