Skip to content

Commit

Permalink
frodo-kem: metadata cleanups (#87)
Browse files Browse the repository at this point in the history
- Corrects old links to `frodo-kem-rs` to use new `frodo-kem` name
- Bumps the package version to `0.0.0` since it hasn't been released
- Groups Cargo.toml closer to our other packages
  • Loading branch information
tarcieri authored Jan 19, 2025
1 parent 3b99822 commit 5727da2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
18 changes: 9 additions & 9 deletions frodo-kem/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[package]
name = "frodo-kem"
version = "0.0.0"
description = "Pure Rust implementation of FrodoKEM and eFrodoKEM"
authors = ["The RustCrypto Team"]
categories = ["cryptography"]
description = "A pure rust implementation of FrodoKEM and eFrodoKEM"
documentation = "https://docs.rs/frodo-kem"
edition = "2021"
exclude = ["tests/**", "bench/**", "examples/**", ".github/**"]
homepage = "https://github.com/RustCrypto/KEMs"
homepage = "https://github.com/RustCrypto/KEMs/tree/master/frodo-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography"]
keywords = ["quantum", "post", "zero", "knowledge", "encryption"]
exclude = ["tests/**", "bench/**", "examples/**", ".github/**"]
license = "Apache-2.0 OR MIT"
name = "frodo-kem"
readme = "README.md"
repository = "https://github.com/RustCrypto/KEMs/frodo-kem"
version = "0.4.0"
edition = "2021"

[features]
default = [
Expand Down Expand Up @@ -111,4 +111,4 @@ required-features = ["efrodo"]
name = "frodo"
harness = false
path = "benches/frodo.rs"
required-features = ["frodo"]
required-features = ["frodo"]
14 changes: 6 additions & 8 deletions frodo-kem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
[![Crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
![Apache2/MIT licensed][license-image]
[![Downloads][downloads-image]][crate-link]
![build](https://github.com/RustCrypto/KEMs/actions/workflows/frodo-kem.yml/badge.svg)
![MSRV][msrv-image]

Expand Down Expand Up @@ -60,7 +59,7 @@ When in doubt use the FrodoKEM algorithm variants.
To speed up AES, there are a few options available:

- `RUSTFLAGS="--cfg aes_armv8" cargo build --release` ensures that the ARMv8 AES instructions are used if available.
- `frodo-kem-rs = { version = "0.3", features = ["openssl"] }` uses the `openssl` crate for AES.
- `frodo-kem = { version = "0.3", features = ["openssl"] }` uses the `openssl` crate for AES.

By default, the `aes` feature auto-detects the best AES implementation for your platform
for x86 and x86_64,
Expand Down Expand Up @@ -107,10 +106,9 @@ conditions.
[//]: # (badges)

[RustCrypto]: https://github.com/rustcrypto
[crate-image]: https://img.shields.io/crates/v/frodo-kem-rs.svg
[crate-link]: https://crates.io/crates/frodo-kem-rs
[docs-image]: https://docs.rs/frodo-kem-rs/badge.svg
[docs-link]: https://docs.rs/frodo-kem-rs/
[crate-image]: https://img.shields.io/crates/v/frodo-kem.svg?logo=rust
[crate-link]: https://crates.io/crates/frodo-kem
[docs-image]: https://docs.rs/frodo-kem/badge.svg
[docs-link]: https://docs.rs/frodo-kem/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[downloads-image]: https://img.shields.io/crates/d/frodo-kem-rs.svg
[msrv-image]: https://img.shields.io/badge/rustc-1.82+-blue.svg
[msrv-image]: https://img.shields.io/badge/rustc-1.82+-blue.svg

0 comments on commit 5727da2

Please sign in to comment.