Skip to content

Commit 9731f30

Browse files
committed
docs(README): optimize desc of crate
1 parent 524e922 commit 9731f30

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
This repository hosts both:
88

9-
* [ktls](./ktls): higher-level, safe wrappers over kTLS
10-
* [ktls-sys](./ktls-sys): the raw system interface for kTLS on Linux
9+
* [ktls](./ktls): high-level APIs for configuring kTLS (kernel TLS offload) on top of [rustls].
10+
* [ktls-sys](./ktls-sys): the raw system interface for kTLS on Linux (deprecated).
1111

1212
## License
1313

ktls/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@
44
[![Coverage Status (codecov.io)](https://codecov.io/gh/rustls/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/rustls/ktls/)
55
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE-MIT)
66

7-
# ktls
7+
# `ktls` - Kernel TLS offload (kTLS) support built on top of [rustls].
88

9-
Configures kTLS ([kernel TLS
10-
offload](https://www.kernel.org/doc/html/latest/networking/tls-offload.html))
11-
for any type that implements `AsRawFd`, given a rustls `ServerConnection`.
9+
This crate provides high-level APIs for configuring [kernel TLS offload] (kTLS).
1210

1311
## License
1412

1513
This project is primarily distributed under the terms of both the MIT license
1614
and the Apache License (Version 2.0).
1715

1816
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
17+
18+
[kernel TLS offload]: https://www.kernel.org/doc/html/latest/networking/tls-offload.html
19+
[rustls]: https://docs.rs/rustls/latest/rustls/kernel/index.html

0 commit comments

Comments
 (0)