Skip to content

docs: shorten the README - #43

Merged
BKPepe merged 1 commit into
masterfrom
docs-readme
Nov 11, 2026
Merged

BKPepe merged 1 commit into
masterfrom
docs-readme

Conversation

@BKPepe

@BKPepe BKPepe commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

The README is now tables and callouts instead of long paragraphs. Only the steps for running the parity test by hand and for regenerating the golden data stay collapsed. How to release and the crates.io setup move to RELEASING.md unchanged.

The ChaCha20 row of the cipher table is gone. Its numbers no longer match a newer measurement and have to be taken again on the board.

Cargo.toml and tls.rs no longer say ring fails to build outside x86 and ARM. Stock OpenWrt ships mbedTLS, so libopenssl is a dependency of the package.

The README is now tables and callouts instead of long paragraphs. Only the
steps for running the parity test by hand and for regenerating the golden
data are collapsed. How to release and the crates.io setup move to
RELEASING.md unchanged.

The ChaCha20 row of the cipher table is gone. Its numbers no longer match
a newer measurement and have to be taken again on the board.

Cargo.toml and tls.rs no longer say ring fails to build outside x86 and
ARM. Stock OpenWrt ships mbedTLS, so libopenssl is a dependency of the
package.
@BKPepe
BKPepe merged commit 494736d into master Nov 11, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant