Skip to content

Commit

Permalink
Standardize READMEs a little
Browse files Browse the repository at this point in the history
  • Loading branch information
fasterthanlime committed Aug 17, 2024
1 parent 0c9e410 commit b763bcf
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 13 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# ktls

[![Crates.io](https://img.shields.io/crates/v/ktls)](https://crates.io/crates/ktls)
[![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)

# ktls

This repository hosts both:

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`.
* [ktls](./ktls): higher-level, safe wrappers over kTLS
* [ktls-sys](./ktls-sys): the raw system interface for kTLS on Linux

## License

Expand Down
4 changes: 3 additions & 1 deletion ktls-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ name = "ktls-sys"
version = "1.0.1"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/bearcove/ktls-sys"
repository = "https://github.com/rustls/ktls-sys"
documentation = "https://docs.rs/ktls-sys"
authors = ["Amos Wenger <[email protected]>"]
readme = "README.md"
description = """
FFI bindings for `linux/tls.h`
"""
rust-version = "1.75"

[dependencies]
10 changes: 5 additions & 5 deletions ktls-sys/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[![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)

# ktls-sys

`linux/tls.h` bindings, for TLS kernel offload.
Expand All @@ -6,11 +11,6 @@ Generated with `bindgen tls.h -o src/bindings.rs`

See <https://github.com/bearcove/ktls> for a higher-level / safer interface.

## Status

[![test pipeline](https://github.com/bearcove/ktls-sys/actions/workflows/test.yml/badge.svg)](https://github.com/bearcove/ktls-sys/actions/workflows/test.yml?query=branch%3Amain)
[![Coverage Status (codecov.io)](https://codecov.io/gh/bearcove/ktls-sys/branch/main/graph/badge.svg)](https://codecov.io/gh/bearcove/ktls-sys/)

## License

This project is primarily distributed under the terms of both the MIT license
Expand Down
File renamed without changes.
17 changes: 17 additions & 0 deletions ktls/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[![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)

# ktls

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`.

## 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.
2 changes: 1 addition & 1 deletion rust-toolchain.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[toolchain]
channel = "1.80.1"
channel = "1.75.0"
components = ["llvm-tools", "clippy", "rust-src"]

0 comments on commit b763bcf

Please sign in to comment.