PR 62: partial: adjust README

Author: cxw620

README.md

@@ -1,13 +1,14 @@
-[![test pipeline](https://github.com/hapsoc/ktls/actions/workflows/test.yml/badge.svg)](https://github.com/hapsoc/ktls/actions/workflows/test.yml?query=branch%3Amain)
-[![Coverage Status (codecov.io)](https://codecov.io/gh/hapsoc/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/hapsoc/ktls/)
-[![license: MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](LICENSE-MIT)
+[![Test pipeline](https://github.com/rustls/ktls/actions/workflows/ci.yml/badge.svg)](https://github.com/rustls/ktls/actions/workflows/ci.yml?query=branch%3Amain)
+[![Coverage Status (codecov.io)](https://codecov.io/gh/rustls/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/rustls/ktls/)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE-MIT)
 
 # ktls
 
 This repository hosts both:
 
-  * [ktls](./ktls): higher-level, safe wrappers over kTLS
-  * [ktls-sys](./ktls-sys): the raw system interface for kTLS on Linux
+  * [ktls](./ktls): high-level APIs for configuring kTLS (kernel TLS offload) on top of [rustls].
+  * [ktls-util](./ktls-util): utilities for crate `ktls`.
+  * [ktls-sys](./ktls-sys): the raw system interface for kTLS on Linux (deprecated).
 
 ## License
 

ktls-sys/README.md

@@ -1,15 +1,19 @@
-[![test pipeline](https://github.com/hapsoc/ktls/actions/workflows/test.yml/badge.svg)](https://github.com/hapsoc/ktls/actions/workflows/test.yml?query=branch%3Amain)
-[![Coverage Status (codecov.io)](https://codecov.io/gh/hapsoc/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/hapsoc/ktls/)
 [![Crates.io](https://img.shields.io/crates/v/ktls-sys)](https://crates.io/crates/ktls-sys)
-[![license: MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](LICENSE-MIT)
+[![Docs.rs](https://docs.rs/ktls-sys/badge.svg)](https://docs.rs/ktls-sys)
+[![Test pipeline](https://github.com/rustls/ktls/actions/workflows/ci.yml/badge.svg)](https://github.com/rustls/ktls/actions/workflows/ci.yml?query=branch%3Amain)
+[![Coverage Status (codecov.io)](https://codecov.io/gh/rustls/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/rustls/ktls/)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE-MIT)
 
 # ktls-sys
 
+> [!WARNING]
+> This crate is deprecated.
+
 `linux/tls.h` bindings, for TLS kernel offload.
 
 Generated with `bindgen tls.h -o src/bindings.rs`
 
-See <https://github.com/bearcove/ktls> for a higher-level / safer interface.
+See <https://github.com/rustls/ktls> for a higher-level / safer interface.
 
 ## License
 

ktls-util/README.md

@@ -0,0 +1,21 @@
+[![Crates.io](https://img.shields.io/crates/v/ktls)](https://crates.io/crates/ktls-util)
+[![Docs.rs](https://docs.rs/ktls/badge.svg)](https://docs.rs/ktls-util)
+[![Test pipeline](https://github.com/rustls/ktls/actions/workflows/ci.yml/badge.svg)](https://github.com/rustls/ktls/actions/workflows/ci.yml?query=branch%3Amain)
+[![Coverage Status (codecov.io)](https://codecov.io/gh/rustls/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/rustls/ktls/)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE-MIT)
+
+# `ktls-util` - Utilities for crate `ktls`
+
+## MSRV
+
+1.77.0
+
+## LICENSE
+
+This project is primarily distributed under the terms of both the MIT license
+and the Apache License (Version 2.0).
+
+See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
+
+[kernel TLS offload]: https://www.kernel.org/doc/html/latest/networking/tls-offload.html
+[rustls]: https://docs.rs/rustls/latest/rustls/kernel/index.html

ktls/README.md

@@ -1,17 +1,24 @@
-[![test pipeline](https://github.com/hapsoc/ktls/actions/workflows/test.yml/badge.svg)](https://github.com/hapsoc/ktls/actions/workflows/test.yml?query=branch%3Amain)
-[![Coverage Status (codecov.io)](https://codecov.io/gh/hapsoc/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/hapsoc/ktls/)
 [![Crates.io](https://img.shields.io/crates/v/ktls)](https://crates.io/crates/ktls)
-[![license: MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](LICENSE-MIT)
+[![Docs.rs](https://docs.rs/ktls/badge.svg)](https://docs.rs/ktls)
+[![Test pipeline](https://github.com/rustls/ktls/actions/workflows/ci.yml/badge.svg)](https://github.com/rustls/ktls/actions/workflows/ci.yml?query=branch%3Amain)
+[![Coverage Status (codecov.io)](https://codecov.io/gh/rustls/ktls/branch/main/graph/badge.svg)](https://codecov.io/gh/rustls/ktls/)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE-MIT)
 
-# ktls
+# `ktls` - Kernel TLS offload (kTLS) support built on top of [rustls].
 
-Configures kTLS ([kernel TLS
-offload](https://www.kernel.org/doc/html/latest/networking/tls-offload.html))
-for any type that implements `AsRawFd`, given a rustls `ServerConnection`.
+This crate provides high-level APIs for configuring [kernel TLS offload] (kTLS),
+extending the bare minimum functionality provided by [rustls].
 
-## License
+## MSRV
+
+1.77.0
+
+## LICENSE
 
 This project is primarily distributed under the terms of both the MIT license
 and the Apache License (Version 2.0).
 
 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
+
+[kernel TLS offload]: https://www.kernel.org/doc/html/latest/networking/tls-offload.html
+[rustls]: https://docs.rs/rustls/latest/rustls/kernel/index.html