← Watch feed
Add `readme` fields to most crates' `Cargo.toml`s
Public commit record
80/100 · Strong
What the developer wrote
Authored by Matt Corallo
Add `readme` fields to most crates' `Cargo.toml`s
`crates.io` will show any README/README.md which apears in the
crate which is uploaded, but it doesn't consider the README from
the workspace, only if its in the crate itself.
Instead, add the `readme` field so that the workspace README also
gets uploaded.
✓ Descriptive subject✓ Names a concrete action or component✓ Provides detailed explanatory context✓ Explains rationale or failure mode
What changed, and why it matters
This commit only adds README file references to the packaging metadata for several Rust crates. It is a documentation/packaging improvement with no effect on program behavior or security.
Recommended action
No security action needed; this is a routine metadata change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit adds readme = "../README.md" to the Cargo.toml files of nine workspace crates so that crates.io displays the workspace README for each published crate. No source code, dependencies, features, or build configuration were changed.
Changed components
lightning-background-processor/Cargo.tomllightning-block-sync/Cargo.tomllightning-custom-message/Cargo.tomllightning-dns-resolver/Cargo.tomllightning-net-tokio/Cargo.tomllightning-persister/Cargo.tomllightning-transaction-sync/Cargo.tomllightning-types/Cargo.tomllightning/Cargo.tomlInspect captured patch +9 / −0
diff --git a/lightning-background-processor/Cargo.toml b/lightning-background-processor/Cargo.toml
index 44edb97..a515604 100644
--- a/lightning-background-processor/Cargo.toml
+++ b/lightning-background-processor/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Valentine Wallace <vwallace@protonmail.com>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning"
+readme = "../README.md"
description = """
Utilities to perform required background tasks for Rust Lightning.
"""
diff --git a/lightning-block-sync/Cargo.toml b/lightning-block-sync/Cargo.toml
index 2b42e3c..2d992a5 100644
--- a/lightning-block-sync/Cargo.toml
+++ b/lightning-block-sync/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Jeffrey Czyz", "Matt Corallo"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning"
+readme = "../README.md"
description = """
Utilities to fetch the chain data from a block source and feed them into Rust Lightning.
"""
diff --git a/lightning-custom-message/Cargo.toml b/lightning-custom-message/Cargo.toml
index 202edc6..c2feb53 100644
--- a/lightning-custom-message/Cargo.toml
+++ b/lightning-custom-message/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Jeffrey Czyz"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning"
+readme = "../README.md"
description = """
Utilities for supporting custom peer-to-peer messages in LDK.
"""
diff --git a/lightning-dns-resolver/Cargo.toml b/lightning-dns-resolver/Cargo.toml
index 3a3c5f3..3496183 100644
--- a/lightning-dns-resolver/Cargo.toml
+++ b/lightning-dns-resolver/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.3.0+git"
authors = ["Matt Corallo"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning/"
+readme = "../README.md"
description = "A crate which implements DNSSEC resolution for lightning clients over bLIP 32 using `tokio` and the `dnssec-prover` crate."
edition = "2021"
rust-version = "1.75"
diff --git a/lightning-net-tokio/Cargo.toml b/lightning-net-tokio/Cargo.toml
index d5b6df5..f9a4abd 100644
--- a/lightning-net-tokio/Cargo.toml
+++ b/lightning-net-tokio/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Matt Corallo"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning/"
+readme = "../README.md"
description = """
Implementation of the rust-lightning network stack using Tokio.
For Rust-Lightning clients which wish to make direct connections to Lightning P2P nodes, this is a simple alternative to implementing the required network stack, especially for those already using Tokio.
diff --git a/lightning-persister/Cargo.toml b/lightning-persister/Cargo.toml
index 5869f15..d62198f 100644
--- a/lightning-persister/Cargo.toml
+++ b/lightning-persister/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Valentine Wallace", "Matt Corallo"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning"
+readme = "../README.md"
description = """
Utilities for LDK data persistence and retrieval.
"""
diff --git a/lightning-transaction-sync/Cargo.toml b/lightning-transaction-sync/Cargo.toml
index 6cf75ff..c04f4ad 100644
--- a/lightning-transaction-sync/Cargo.toml
+++ b/lightning-transaction-sync/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Elias Rohrer"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning"
+readme = "../README.md"
description = """
Utilities for syncing LDK via the transaction-based `Confirm` interface.
"""
diff --git a/lightning-types/Cargo.toml b/lightning-types/Cargo.toml
index 2abaaa9..89bd919 100644
--- a/lightning-types/Cargo.toml
+++ b/lightning-types/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.3.0+git"
authors = ["Matt Corallo"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning/"
+readme = "../README.md"
description = """
Basic types which are used in the lightning network
"""
diff --git a/lightning/Cargo.toml b/lightning/Cargo.toml
index 47ae12f..9df4a72 100644
--- a/lightning/Cargo.toml
+++ b/lightning/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0+git"
authors = ["Matt Corallo"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/lightningdevkit/rust-lightning/"
+readme = "../README.md"
description = """
A Complete Bitcoin Lightning Library in Rust.
Handles the core functionality of the Lightning Network, allowing clients to implement custom wallet, chain interactions, storage and network logic without enforcing a specific runtime.
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.