Update crate READMEs (#477)

- Update MSRV badges. - Remove the text-based "documentation" link. It's redundant, especially when readme is included in crate docs. - Remove the "Minimum Supported Rust Version" section. After update to the 2024 edition we have a more relaxed MSRV policy, so the MSRV badge should be sufficient. - Remove the "SemVer Policy" section. After the MSRV policy change we have the default SemVer policy (i.e. all features and public APIs are subject to SemVer), so we do not need to say it explicitly.
RustCrypto · Feb 28, 2025 · 0ab21fa · 0ab21fa
1 parent cbdb9f0
commit 0ab21fa
Show file tree

Hide file tree

Showing 20 changed files with 20 additions and 300 deletions.
diff --git a/aes/README.md b/aes/README.md
@@ -15,8 +15,6 @@ This crate implements the low-level AES block function, and is intended
 for use for implementing higher-level constructions *only*. It is NOT
 intended for direct use in applications.
 
-[Documentation][docs-link]
-
 <img src="https://raw.githubusercontent.com/RustCrypto/media/85f62bb/img/block-ciphers/aes-round.svg" width="480px">
 
 ## Security
@@ -41,18 +39,6 @@ All implementations contained in the crate are designed to execute in constant
 time, either by relying on hardware intrinsics (i.e. AES-NI on x86/x86_64), or
 using a portable implementation based on bitslicing.
 
-## Minimum Supported Rust Version
-
-Rust **1.72** or higher.
-
-Minimum supported Rust version can be changed in future releases, but it will
-be done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -75,7 +61,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/aes/badge.svg
 [docs-link]: https://docs.rs/aes/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.72+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
 [chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260039-block-ciphers
 [build-image]: https://github.com/RustCrypto/block-ciphers/workflows/aes/badge.svg?branch=master&event=push

diff --git a/aria/README.md b/aria/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [ARIA] block cipher.
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/aria/badge.svg
 [docs-link]: https://docs.rs/aria/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/belt-block/README.md b/belt-block/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [BelT] block cipher specified in [STB 34.101.31-2020].
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/belt-block/badge.svg
 [docs-link]: https://docs.rs/belt-block/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/blowfish/README.md b/blowfish/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [Blowfish block cipher][1].
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/blowfish/badge.svg
 [docs-link]: https://docs.rs/blowfish/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/camellia/README.md b/camellia/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [Camellia block cipher][1].
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/camellia/badge.svg
 [docs-link]: https://docs.rs/camellia/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/cast5/README.md b/cast5/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [CAST5 block cipher][1].
 
-[Documentation][docs-link]
-
 <img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/block-ciphers/cast5.png" width="480px">
 
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
@@ -26,18 +24,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -60,7 +46,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/cast5/badge.svg
 [docs-link]: https://docs.rs/cast5/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/cast6/README.md b/cast6/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [CAST6 block cipher][1].
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/cast6/badge.svg
 [docs-link]: https://docs.rs/cast6/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/des/README.md b/des/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [DES cipher][1], including triple DES (3DES).
 
-[Documentation][docs-link]
-
 <img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/block-ciphers/des.png" width="310px">
 
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
@@ -26,18 +24,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -60,7 +46,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/des/badge.svg
 [docs-link]: https://docs.rs/des/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/gift/README.md b/gift/README.md
@@ -10,8 +10,6 @@
 
 Pure Rust implementation of the [Gift block cipher][1].
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/gift-cipher/badge.svg
 [docs-link]: https://docs.rs/gift-cipher/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

diff --git a/idea/README.md b/idea/README.md
@@ -10,8 +10,6 @@
 
 Experimental Pure Rust implementation of the [IDEA block cipher][1].
 
-[Documentation][docs-link]
-
 ## ⚠️ Security Warning: [Hazmat!][hazmat-link]
 
 This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
 
 USE AT YOUR OWN RISK!
 
-## Minimum Supported Rust Version
-
-Rust **1.65** or higher.
-
-Minimum supported Rust version can be changed in the future, but it will be
-done with a minor version bump.
-
-## SemVer Policy
-
-- All on-by-default features of this library are covered by SemVer
-- MSRV is considered exempt from SemVer as noted above
-
 ## License
 
 Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
 [docs-image]: https://docs.rs/idea/badge.svg
 [docs-link]: https://docs.rs/idea/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
-[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
 [hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
 [hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg