Added Badges
This commit is contained in:
parent
edadde3923
commit
cb8af85995
4 changed files with 24 additions and 7 deletions
|
@ -12,6 +12,10 @@ license = "MIT"
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
[badges]
|
||||||
|
maintenance = { status = "actively-developed" }
|
||||||
|
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
p256 = {version = "0.9", features = ["zeroize", "ecdh", "arithmetic", "pem"]}
|
p256 = {version = "0.9", features = ["zeroize", "ecdh", "arithmetic", "pem"]}
|
||||||
rand_core = {version = "0.6", features = ["getrandom"]}
|
rand_core = {version = "0.6", features = ["getrandom"]}
|
||||||
|
|
10
README.md
10
README.md
|
@ -1,8 +1,10 @@
|
||||||
# double-ratchet-2
|
|
||||||
|
|
||||||
[![Crate](https://img.shields.io/crates/v/double-ratchet-2)](https://crates.io/crates/double-ratchet-2)
|
[![Crate](https://img.shields.io/crates/v/double-ratchet-2)](https://crates.io/crates/double-ratchet-2)
|
||||||
[![License](https://img.shields.io/github/license/Dione-Software/double-ratchet-2)](https://github.com/Dione-Software/double-ratchet-2/blob/main/LICENSE)
|
[![License](https://img.shields.io/github/license/Dione-Software/double-ratchet-2)](https://github.com/Dione-Software/double-ratchet-2/blob/main/LICENSE)
|
||||||
[![Actions](https://img.shields.io/github/workflow/status/Dione-Software/double-ratchet-2/Rust)](https://github.com/Dione-Software/double-ratchet-2/actions)
|
[![Coverage Status](https://coveralls.io/repos/github/Dione-Software/double-ratchet-2/badge.svg?branch=main)](https://coveralls.io/github/Dione-Software/double-ratchet-2?branch=main)
|
||||||
|
[![Workflow Status](https://github.com/Dione-Software/double-ratchet-2/actions/workflows/rust.yml/badge.svg)](https://github.com/Dione-Software/double-ratchet-2/actions/workflows/rust.yml)
|
||||||
|
![Maintenance](https://img.shields.io/badge/maintenance-activly--developed-brightgreen.svg)
|
||||||
|
|
||||||
|
# double-ratchet-2
|
||||||
|
|
||||||
Implementation of the double ratchet system/encryption as specified by [Signal][1].
|
Implementation of the double ratchet system/encryption as specified by [Signal][1].
|
||||||
|
|
||||||
|
@ -118,4 +120,6 @@ TODO:
|
||||||
[2]: https://signal.org/docs/specifications/doubleratchet/#recommended-cryptographic-algorithms
|
[2]: https://signal.org/docs/specifications/doubleratchet/#recommended-cryptographic-algorithms
|
||||||
[3]: https://signal.org/docs/specifications/doubleratchet/#double-ratchet-with-header-encryption
|
[3]: https://signal.org/docs/specifications/doubleratchet/#double-ratchet-with-header-encryption
|
||||||
|
|
||||||
|
Current version: 0.3.1
|
||||||
|
|
||||||
License: MIT
|
License: MIT
|
||||||
|
|
13
README.tpl
Normal file
13
README.tpl
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
[![Crate](https://img.shields.io/crates/v/double-ratchet-2)](https://crates.io/crates/double-ratchet-2)
|
||||||
|
[![License](https://img.shields.io/github/license/Dione-Software/double-ratchet-2)](https://github.com/Dione-Software/double-ratchet-2/blob/main/LICENSE)
|
||||||
|
[![Coverage Status](https://coveralls.io/repos/github/Dione-Software/double-ratchet-2/badge.svg?branch=main)](https://coveralls.io/github/Dione-Software/double-ratchet-2?branch=main)
|
||||||
|
[![Workflow Status](https://github.com/Dione-Software/double-ratchet-2/actions/workflows/rust.yml/badge.svg)](https://github.com/Dione-Software/double-ratchet-2/actions/workflows/rust.yml)
|
||||||
|
{{badges}}
|
||||||
|
|
||||||
|
# {{crate}}
|
||||||
|
|
||||||
|
{{readme}}
|
||||||
|
|
||||||
|
Current version: {{version}}
|
||||||
|
|
||||||
|
License: {{license}}
|
|
@ -1,7 +1,3 @@
|
||||||
//! [![Crate](https://img.shields.io/crates/v/double-ratchet-2)](https://crates.io/crates/double-ratchet-2)
|
|
||||||
//! [![License](https://img.shields.io/github/license/Dione-Software/double-ratchet-2)](https://github.com/Dione-Software/double-ratchet-2/blob/main/LICENSE)
|
|
||||||
//! [![Actions](https://img.shields.io/github/workflow/status/Dione-Software/double-ratchet-2/Rust)](https://github.com/Dione-Software/double-ratchet-2/actions)
|
|
||||||
//!
|
|
||||||
//! Implementation of the double ratchet system/encryption as specified by [Signal][1].
|
//! Implementation of the double ratchet system/encryption as specified by [Signal][1].
|
||||||
//!
|
//!
|
||||||
//! The implementation follows the cryptographic recommendations provided by [Signal][2].
|
//! The implementation follows the cryptographic recommendations provided by [Signal][2].
|
||||||
|
|
Loading…
Reference in a new issue