From cb8af85995c0cfc86f3e5ca5412c2473c7c78656 Mon Sep 17 00:00:00 2001 From: Hannes Date: Fri, 18 Jun 2021 12:16:01 +0200 Subject: [PATCH] Added Badges --- Cargo.toml | 4 ++++ README.md | 10 +++++++--- README.tpl | 13 +++++++++++++ src/lib.rs | 4 ---- 4 files changed, 24 insertions(+), 7 deletions(-) create mode 100644 README.tpl diff --git a/Cargo.toml b/Cargo.toml index 1eaa3bb..2867e0b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,6 +12,10 @@ license = "MIT" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +[badges] +maintenance = { status = "actively-developed" } + + [dependencies] p256 = {version = "0.9", features = ["zeroize", "ecdh", "arithmetic", "pem"]} rand_core = {version = "0.6", features = ["getrandom"]} diff --git a/README.md b/README.md index 66902a4..ffba8a2 100644 --- a/README.md +++ b/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) [![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]. @@ -118,4 +120,6 @@ TODO: [2]: https://signal.org/docs/specifications/doubleratchet/#recommended-cryptographic-algorithms [3]: https://signal.org/docs/specifications/doubleratchet/#double-ratchet-with-header-encryption +Current version: 0.3.1 + License: MIT diff --git a/README.tpl b/README.tpl new file mode 100644 index 0000000..71779cc --- /dev/null +++ b/README.tpl @@ -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}} \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index a7174d4..403b419 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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]. //! //! The implementation follows the cryptographic recommendations provided by [Signal][2].