Update README.md

This commit is contained in:
Romain Ruetschi
2018-04-08 21:43:40 +02:00
parent 522b898950
commit 6cc05c4184

View File

@ -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).