v0.0.5

Author: sebastienrousseau

Cargo.lock

@@ -30,7 +30,7 @@ license = "MIT OR Apache-2.0"
 name = "kyberlib"
 readme = "README.md"
 repository = "https://github.com/sebastienrousseau/kyberlib"
-version = "0.0.4"
+version = "0.0.5"
 
 [dependencies]
 aes = { version = "0.8.4", optional = true }

Cargo.toml

@@ -18,17 +18,9 @@ A Robust Rust Library for CRYSTALS-Kyber Post-Quantum Cryptography.
 <center>
 <!-- markdownlint-enable MD033 MD041 -->
 
-[![Made With Rust][made-with-rust-badge]][05]
-[![Crates.io][crates-badge]][07]
-[![Lib.rs][libs-badge]][09]
-[![Docs.rs][docs-badge]][08]
-[![License][license-badge]][02]
-
-• [Website][00]
-• [Documentation][08]
-• [Report Bug][03]
-• [Request Feature][03]
-• [Contributing Guidelines][04]
+[![Made With Love][made-with-rust]][05] [![Crates.io][crates-badge]][07] [![Lib.rs][libs-badge]][09] [![Docs.rs][docs-badge]][08] [![License][license-badge]][02] [![Codecov][codecov-badge]][15]
+
+• [Website][00] • [Documentation][08] • [Report Bug][03] • [Request Feature][03] • [Contributing Guidelines][04]
 
 <!-- markdownlint-disable MD033 MD041 -->
 </center>
@@ -73,7 +65,7 @@ It takes just a few minutes to get up and running with `kyberlib`.
 ### Requirements
 
 The minimum supported Rust toolchain version is currently Rust
-**1.56.0** or later (stable).
+**1.60** or later (stable).
 
 ### Installation
 
@@ -95,7 +87,7 @@ To use the `kyberlib` library in your project, add the following to your
 
 ```toml
 [dependencies]
-kyberlib = "0.0.4"
+kyberlib = "0.0.5"
 ```
 
 Add the following to your `main.rs` file:
@@ -303,10 +295,12 @@ providing a lot of useful suggestions on how to improve this project.
 [12]: https://www.reddit.com/r/rust/ "Reddit"
 [13]: https://www.rust-lang.org/learn/get-started "Rust"
 [14]: https://github.com/Argyle-Software/kyber "Kyber from Argyle-Software"
+[15]: https://codecov.io/gh/sebastienrousseau/kyberlib "Codecov"
 
-[crates-badge]: https://img.shields.io/crates/v/kyberlib.svg?style=for-the-badge 'Crates.io badge'
+[crates-badge]: https://img.shields.io/crates/v/kyberlib.svg?style=for-the-badge 'Crates.io'
+[codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/kyberlib?style=for-the-badge&token=oEisyTucB5 'Codecov'
 [divider]: https://kura.pro/common/images/elements/divider.svg "divider"
-[docs-badge]: https://img.shields.io/docsrs/kyberlib.svg?style=for-the-badge 'Docs.rs badge'
-[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.1-orange.svg?style=for-the-badge 'Lib.rs badge'
-[license-badge]: https://img.shields.io/crates/l/kyberlib.svg?style=for-the-badge 'License badge'
-[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust badge'
+[docs-badge]: https://img.shields.io/docsrs/kyberlib.svg?style=for-the-badge 'Docs.rs'
+[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.5-orange.svg?style=for-the-badge 'Lib.rs'
+[license-badge]: https://img.shields.io/crates/l/kyberlib.svg?style=for-the-badge 'License'
+[made-with-rust]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust'

README.md

@@ -40,30 +40,6 @@ A Robust Rust Library for CRYSTALS-Kyber Post-Quantum Cryptography
 
 A Robust Rust Library for CRYSTALS-Kyber Post-Quantum Cryptography
 
-## Features ✨
-
-### Core Features
-
-- **`no_std` compatible**: No dependence on the Rust standard library
-- **Avoid allocations**: Uses stack-based data structures only
-- **Configurable**: Features to enable different parameter sets
-- **Optimised x86_64**: Uses assembly for performance-critical code, including an optimised AVX2 version by default.
-- **Safe code**: Reference implementations have no `unsafe` blocks
-- **WebAssembly Support**: Can be compiled to WASM using wasm-bindgen.
-
-### Advanced Features
-
-- **Allocation-free Guarantee**: KyberLib guarantees all its core cryptography operations are free of heap allocations.
-- **Assembly Optimizations**: The x86_64 assembly implementations use AVX2 instructions for high performance.
-- **Security**: KyberLib contains no unsafe code in its public API surface.
-
-## Functionality 📚
-
-- **Key Generation**: Create public/private key pairs
-- **Encapsulation**: Encapsulate a shared secret with a public key
-- **Decapsulation**: Decapsulate a shared secret with a private key
-- **Key Exchange**: Perform authenticated key exchanges
-
 [0]: https://kyberlib.com/
 [2]: http://opensource.org/licenses/MIT
 [3]: https://github.com/sebastienrousseau/kyberlib/kyberlib/issues
@@ -73,11 +49,10 @@ A Robust Rust Library for CRYSTALS-Kyber Post-Quantum Cryptography
 [8]: https://docs.rs/kyberlib
 [9]: https://lib.rs/crates/kyberlib
 
-[banner]: https://via.placeholder.com/1500x500.png/000000/FFFFFF?text=kyberlib "kyberlib's banner"
 [crates-badge]: https://img.shields.io/crates/v/kyberlib.svg?style=for-the-badge 'Crates.io badge'
 [divider]: https://via.placeholder.com/1024x1.png/d8dee4/FFFFFF?text=− "kyberlib's divider"
 [docs-badge]: https://img.shields.io/docsrs/kyberlib.svg?style=for-the-badge 'Docs.rs badge'
-[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.1-orange.svg?style=for-the-badge 'Lib.rs badge'
+[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.5-orange.svg?style=for-the-badge 'Lib.rs badge'
 [license-badge]: https://img.shields.io/crates/l/kyberlib.svg?style=for-the-badge 'License badge'
 [made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust badge'
 

TEMPLATE.md

@@ -0,0 +1,4 @@
+edition = "2018"
+max_width = 72
+tab_spaces = 4
+use_field_init_shorthand = true