← Watch feed
Remove redundant readme sections in packages
Public commit record
68/100 · Adequate
What the developer wrote
Authored by Nick Johnson
Remove redundant readme sections in packages
The MSRV and License sections in each package are redundant with the
required information in the package manifest. The manifest info is already
shown on sites like crates.io, so not much benefit of listing it twice.
This removes another spot to update on changes.
✓ Descriptive subject✓ Names a concrete action or component✓ Provides detailed explanatory context
What changed, and why it matters
This commit only removes documentation sections from README files in multiple Rust packages. It deletes redundant mentions of the minimum Rust version and licensing information, which are already present in the package manifest files. There are no code changes, no functional changes, and no security implications.
Recommended action
No security action required. This is a routine documentation cleanup. Reviewers may optionally verify that the removed MSRV and license information remains accurate in each crate's Cargo.toml manifest.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit removes ‘Minimum Supported Rust Version (MSRV)’ and ‘Licensing’ sections from ten README.md files across workspace crates (addresses, base58, bip158, chacha20_poly1305, consensus_encoding, crypto, hashes, p2p, primitives, units). The stated rationale is that this information is duplicated in the package manifests (Cargo.toml) and displayed on crates.io, so maintaining it in two places is unnecessary. The diff contains only deletions of Markdown text; no Rust source, build configuration, or dependency files were modified.
Changed components
addresses/README.mdbase58/README.mdbip158/README.mdchacha20_poly1305/README.mdconsensus_encoding/README.mdcrypto/README.mdhashes/README.mdp2p/README.mdprimitives/README.mdunits/README.mdInspect captured patch +0 / −70
diff --git a/addresses/README.md b/addresses/README.md
index 6e092a90..a7fdf225 100644
--- a/addresses/README.md
+++ b/addresses/README.md
@@ -1,7 +1,3 @@
# Bitcoin Receive
Types and logic required to receive bitcoin - i.e., bitcoin addresses.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
diff --git a/base58/README.md b/base58/README.md
index 8282e596..34b576db 100644
--- a/base58/README.md
+++ b/base58/README.md
@@ -19,12 +19,3 @@ obviously named ones differ from this crate because:
This crate uses [bitcoin_hashes](https://crates.io/crates/bitcoin_hashes) when hashing to calculate
the checksum.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](../LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
diff --git a/bip158/README.md b/bip158/README.md
index cf4e3674..547ee29d 100644
--- a/bip158/README.md
+++ b/bip158/README.md
@@ -1,12 +1,3 @@
# BIP-158
Implementation of [BIP-158](https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki) golomb coded block filters for private light client set membership query.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
diff --git a/chacha20_poly1305/README.md b/chacha20_poly1305/README.md
index 0b5c7388..7789b0cb 100644
--- a/chacha20_poly1305/README.md
+++ b/chacha20_poly1305/README.md
@@ -3,7 +3,3 @@
An authenticated encryption with associated data (AEAD) algorithm implemented with the ChaCha20 stream cipher and the Poly1305 message authentication code (MAC).
This implementation is maintained by the rust-bitcoin community and has a focus on a bare-bones API suitable for the bitcoin ecosystem.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
diff --git a/consensus_encoding/README.md b/consensus_encoding/README.md
index f6776622..63f6b3cd 100644
--- a/consensus_encoding/README.md
+++ b/consensus_encoding/README.md
@@ -1,12 +1,3 @@
# Bitcoin Consensus Encoding
This crate provides traits that can be used to encode/decode objects in a consensus-consistent way.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.63.0**.
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](../LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
diff --git a/crypto/README.md b/crypto/README.md
index 3eef6e9e..f1e74122 100644
--- a/crypto/README.md
+++ b/crypto/README.md
@@ -1,7 +1,3 @@
# Cryptography
Types and logic required to support cryptography i.e., bitcoin keys.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
diff --git a/hashes/README.md b/hashes/README.md
index d5ac1941..3f6dfd8d 100644
--- a/hashes/README.md
+++ b/hashes/README.md
@@ -7,10 +7,6 @@ since these are needed to display hashes anyway.
[Documentation](https://docs.rs/bitcoin_hashes/)
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
-
## Contributions
Contributions are welcome, including additional hash function implementations.
diff --git a/p2p/README.md b/p2p/README.md
index 53412797..23d3f939 100644
--- a/p2p/README.md
+++ b/p2p/README.md
@@ -1,12 +1,3 @@
# Rust Bitcoin Peer to Peer Message Types
This crate provides data types used in the Bitcoin peer-to-peer protocol.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](../LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
diff --git a/primitives/README.md b/primitives/README.md
index 3255b8c4..979cc40d 100644
--- a/primitives/README.md
+++ b/primitives/README.md
@@ -7,12 +7,3 @@ This crate provides primitive data types that are used throughout the
Functions marked as unstable (e.g. `foo__unstable`) are not guaranteed to uphold semver compliance.
They are primarily provided to support `rust-bitcoin`.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](../LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
diff --git a/units/README.md b/units/README.md
index f3430391..69db8748 100644
--- a/units/README.md
+++ b/units/README.md
@@ -1,12 +1,3 @@
# Bitcoin Units
This crate provides basic Bitcoin numeric units such as `Amount`.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.74.0**.
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](../LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.