Skip to content

Commit 0ab21fa

Browse files
newpavlovnewpavlov
authored
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.
1 parent cbdb9f0 commit 0ab21fa

File tree

20 files changed

+20
-300
lines changed

20 files changed

+20
-300
lines changed

‎aes/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ This crate implements the low-level AES block function, and is intended
1515
for use for implementing higher-level constructions *only*. It is NOT
1616
intended for direct use in applications.
1717

18-
[Documentation][docs-link]
19-
2018
<img src="https://raw.githubusercontent.com/RustCrypto/media/85f62bb/img/block-ciphers/aes-round.svg" width="480px">
2119

2220
## Security
@@ -41,18 +39,6 @@ All implementations contained in the crate are designed to execute in constant
4139
time, either by relying on hardware intrinsics (i.e. AES-NI on x86/x86_64), or
4240
using a portable implementation based on bitslicing.
4341

44-
## Minimum Supported Rust Version
45-
46-
Rust **1.72** or higher.
47-
48-
Minimum supported Rust version can be changed in future releases, but it will
49-
be done with a minor version bump.
50-
51-
## SemVer Policy
52-
53-
- All on-by-default features of this library are covered by SemVer
54-
- MSRV is considered exempt from SemVer as noted above
55-
5642
## License
5743

5844
Licensed under either of:
@@ -75,7 +61,7 @@ dual licensed as above, without any additional terms or conditions.
7561
[docs-image]: https://docs.rs/aes/badge.svg
7662
[docs-link]: https://docs.rs/aes/
7763
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
78-
[rustc-image]: https://img.shields.io/badge/rustc-1.72+-blue.svg
64+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
7965
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
8066
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260039-block-ciphers
8167
[build-image]: https://github.com/RustCrypto/block-ciphers/workflows/aes/badge.svg?branch=master&event=push

‎aria/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [ARIA] block cipher.
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/aria/badge.svg
5945
[docs-link]: https://docs.rs/aria/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎belt-block/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [BelT] block cipher specified in [STB 34.101.31-2020].
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/belt-block/badge.svg
5945
[docs-link]: https://docs.rs/belt-block/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎blowfish/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [Blowfish block cipher][1].
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/blowfish/badge.svg
5945
[docs-link]: https://docs.rs/blowfish/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎camellia/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [Camellia block cipher][1].
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/camellia/badge.svg
5945
[docs-link]: https://docs.rs/camellia/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎cast5/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [CAST5 block cipher][1].
1212

13-
[Documentation][docs-link]
14-
1513
<img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/block-ciphers/cast5.png" width="480px">
1614

1715
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
@@ -26,18 +24,6 @@ architectures.
2624

2725
USE AT YOUR OWN RISK!
2826

29-
## Minimum Supported Rust Version
30-
31-
Rust **1.65** or higher.
32-
33-
Minimum supported Rust version can be changed in the future, but it will be
34-
done with a minor version bump.
35-
36-
## SemVer Policy
37-
38-
- All on-by-default features of this library are covered by SemVer
39-
- MSRV is considered exempt from SemVer as noted above
40-
4127
## License
4228

4329
Licensed under either of:
@@ -60,7 +46,7 @@ dual licensed as above, without any additional terms or conditions.
6046
[docs-image]: https://docs.rs/cast5/badge.svg
6147
[docs-link]: https://docs.rs/cast5/
6248
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
63-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
49+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6450
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6551
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6652
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎cast6/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [CAST6 block cipher][1].
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/cast6/badge.svg
5945
[docs-link]: https://docs.rs/cast6/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎des/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [DES cipher][1], including triple DES (3DES).
1212

13-
[Documentation][docs-link]
14-
1513
<img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/block-ciphers/des.png" width="310px">
1614

1715
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
@@ -26,18 +24,6 @@ architectures.
2624

2725
USE AT YOUR OWN RISK!
2826

29-
## Minimum Supported Rust Version
30-
31-
Rust **1.65** or higher.
32-
33-
Minimum supported Rust version can be changed in the future, but it will be
34-
done with a minor version bump.
35-
36-
## SemVer Policy
37-
38-
- All on-by-default features of this library are covered by SemVer
39-
- MSRV is considered exempt from SemVer as noted above
40-
4127
## License
4228

4329
Licensed under either of:
@@ -60,7 +46,7 @@ dual licensed as above, without any additional terms or conditions.
6046
[docs-image]: https://docs.rs/des/badge.svg
6147
[docs-link]: https://docs.rs/des/
6248
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
63-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
49+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6450
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6551
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6652
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎gift/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Pure Rust implementation of the [Gift block cipher][1].
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/gift-cipher/badge.svg
5945
[docs-link]: https://docs.rs/gift-cipher/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

‎idea/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
Experimental Pure Rust implementation of the [IDEA block cipher][1].
1212

13-
[Documentation][docs-link]
14-
1513
## ⚠️ Security Warning: [Hazmat!][hazmat-link]
1614

1715
This crate does not ensure ciphertexts are authentic (i.e. by using a MAC to
@@ -24,18 +22,6 @@ architectures.
2422

2523
USE AT YOUR OWN RISK!
2624

27-
## Minimum Supported Rust Version
28-
29-
Rust **1.65** or higher.
30-
31-
Minimum supported Rust version can be changed in the future, but it will be
32-
done with a minor version bump.
33-
34-
## SemVer Policy
35-
36-
- All on-by-default features of this library are covered by SemVer
37-
- MSRV is considered exempt from SemVer as noted above
38-
3925
## License
4026

4127
Licensed under either of:
@@ -58,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
5844
[docs-image]: https://docs.rs/idea/badge.svg
5945
[docs-link]: https://docs.rs/idea/
6046
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61-
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
47+
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
6248
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
6349
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md
6450
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg

0 commit comments

Comments
 (0)