Skip to content

Commit fdd1e08

Browse files
committed
README.md(s): use logo crate badges
1 parent 8ad39ab commit fdd1e08

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ commonly used in transport encryption protocols (e.g. [TLS]) and hybrid cryptosy
1414

1515
| Name | crates.io | Docs | Description |
1616
|----------------------|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|--------------------|
17-
| [`dhkem`](./dhkem) | [![crates.io](https://img.shields.io/crates/v/dhkem.svg)](https://crates.io/crates/dhkem) | [![Documentation](https://docs.rs/dhkem/badge.svg)](https://docs.rs/dhkem) | Diffie-Hellman KEM |
18-
| [`ml-kem`](./ml-kem) | [![crates.io](https://img.shields.io/crates/v/ml-kem.svg)](https://crates.io/crates/ml-kem) | [![Documentation](https://docs.rs/ml-kem/badge.svg)](https://docs.rs/ml-kem) | Module Lattice KEM |
19-
| [`x-wing`](./x-wing) | [![crates.io](https://img.shields.io/crates/v/x-wing.svg)](https://crates.io/crates/x-wing) | [![Documentation](https://docs.rs/x-wing/badge.svg)](https://docs.rs/x-wing) | Hybrid PQ KEM |
17+
| [`dhkem`](./dhkem) | [![crates.io](https://img.shields.io/crates/v/dhkem.svg?logo=rust)](https://crates.io/crates/dhkem) | [![Documentation](https://docs.rs/dhkem/badge.svg)](https://docs.rs/dhkem) | Diffie-Hellman KEM |
18+
| [`ml-kem`](./ml-kem) | [![crates.io](https://img.shields.io/crates/v/ml-kem.svg?logo=rust)](https://crates.io/crates/ml-kem) | [![Documentation](https://docs.rs/ml-kem/badge.svg)](https://docs.rs/ml-kem) | Module Lattice KEM |
19+
| [`x-wing`](./x-wing) | [![crates.io](https://img.shields.io/crates/v/x-wing.svg?logo=rust)](https://crates.io/crates/x-wing) | [![Documentation](https://docs.rs/x-wing/badge.svg)](https://docs.rs/x-wing) | Hybrid PQ KEM |
2020

2121
## License
2222

dhkem/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ dual licensed as above, without any additional terms or conditions.
5151

5252
[//]: # (badges)
5353

54-
[crate-image]: https://img.shields.io/crates/v/dhkem
54+
[crate-image]: https://img.shields.io/crates/v/dhkem?logo=rust
5555
[crate-link]: https://crates.io/crates/dhkem
5656
[docs-image]: https://docs.rs/dhkem/badge.svg
5757
[docs-link]: https://docs.rs/dhkem/

ml-kem/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ dual licensed as above, without any additional terms or conditions.
6060

6161
[//]: # (badges)
6262

63-
[crate-image]: https://img.shields.io/crates/v/ml-kem
63+
[crate-image]: https://img.shields.io/crates/v/ml-kem?logo=rust
6464
[crate-link]: https://crates.io/crates/ml-kem
6565
[docs-image]: https://docs.rs/ml-kem/badge.svg
6666
[docs-link]: https://docs.rs/ml-kem/

x-wing/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
[![Project Chat][chat-image]][chat-link]
99

1010
Pure Rust implementation of X-Wing, a general-purpose post-quantum/traditional
11-
hybrid key encapsulation mechanism (PQ/T KEM) built on X25519 and ML-KEM-768. Using the crates [x25519_dalek][X25519-DALEK] and [ml-kem][ML-KEM].
11+
hybrid key encapsulation mechanism (PQ/T KEM) built on X25519 and ML-KEM-768.
12+
Built on the [ml-kem] and [x25519-dalek] crates.
1213

1314
Current implementation matches the [draft RFC][RFC-DRAFT] version 04.
1415

@@ -18,7 +19,6 @@ The original paper: [X-Wing The Hybrid KEM You’ve Been Looking For][X-WING-PAP
1819

1920
## About
2021

21-
2222
## ⚠️ Security Warning
2323

2424
The implementation contained in this crate has never been independently audited!
@@ -49,7 +49,7 @@ dual licensed as above, without any additional terms or conditions.
4949

5050
[//]: # (badges)
5151

52-
[crate-image]: https://img.shields.io/crates/v/x-wing
52+
[crate-image]: https://img.shields.io/crates/v/x-wing?logo=rust
5353
[crate-link]: https://crates.io/crates/x-wing
5454
[docs-image]: https://docs.rs/x-wing/badge.svg
5555
[docs-link]: https://docs.rs/x-wing/
@@ -65,5 +65,5 @@ dual licensed as above, without any additional terms or conditions.
6565
[RustCrypto]: https://github.com/rustcrypto
6666
[RFC-DRAFT]: https://datatracker.ietf.org/doc/html/draft-connolly-cfrg-xwing-kem
6767
[X-WING-PAPER]: https://eprint.iacr.org/2024/039.pdf
68-
[X25519-DALEK]: https://crates.io/crates/x25519-dalek
69-
[ML-KEM]: https://crates.io/crates/ml-kem
68+
[x25519-dalek]: https://crates.io/crates/x25519-dalek
69+
[ml-kem]: https://crates.io/crates/ml-kem

0 commit comments

Comments
 (0)