Skip to content

Commit dd22e49

Browse files
authored
README.md: flesh out with some real content (#37)
- Adds "About", "Crates", "License" and "Contribution" sections - Adds badges and links
1 parent 50d6017 commit dd22e49

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# KEMs
2-
Collection of Key Encapsulation Mechanisms written in pure Rust
1+
# [RustCrypto]: Key Encapsulation Mechanisms (KEMs) [![Project Chat][chat-image]][chat-link] [![dependency status][deps-image]][deps-link]
2+
3+
Collection of [Key Encapsulation Mechanisms] (KEMs) written in pure Rust.
4+
5+
# About
6+
7+
KEMs are public-key algorithms designed to secure symmetric key material for transmission, and are
8+
commonly used in transport encryption protocols (e.g. [TLS]) and hybrid cryptosystems (e.g. [HPKE]).
9+
10+
## Crates
11+
12+
| Name | crates.io | Docs | Description |
13+
|----------|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|--------------------|
14+
| `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 |
15+
| `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 |
16+
17+
## License
18+
19+
All crates licensed under either of
20+
21+
- [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
22+
- [MIT license](http://opensource.org/licenses/MIT)
23+
24+
at your option.
25+
26+
### Contribution
27+
28+
Unless you explicitly state otherwise, any contribution intentionally submitted
29+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
30+
dual licensed as above, without any additional terms or conditions.
31+
32+
[//]: # "badges"
33+
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
34+
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/406484-KEMs
35+
[deps-image]: https://deps.rs/repo/github/RustCrypto/KEMs/status.svg
36+
[deps-link]: https://deps.rs/repo/github/RustCrypto/KEMs
37+
38+
[//]: # "links"
39+
[RustCrypto]: https://github.com/RustCrypto/
40+
[Key Encapsulation Mechanisms]: https://en.wikipedia.org/wiki/Key_encapsulation_mechanism
41+
[TLS]: https://en.wikipedia.org/wiki/Transport_Layer_Security
42+
[HPKE]: https://datatracker.ietf.org/doc/rfc9180/

0 commit comments

Comments
 (0)