docs: update cargo features in README to match Cargo.toml#300
Conversation
The README referenced outdated compile-time feature flags `kyoto` and `sp`, which caused build failures for users following the instructions. This commit updates the documentation to use the correct flags `cbf` and `silent-payments` as defined in the current Cargo.toml.
|
Hi @tvpeter, can you please check this out? |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #300 +/- ##
=======================================
Coverage 56.89% 56.89%
=======================================
Files 22 22
Lines 3661 3661
=======================================
Hits 2083 2083
Misses 1578 1578
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
va-an
left a comment
There was a problem hiding this comment.
ACK 4a1ff1b
Not related to this PR, but a possible follow-up: the flags in this example don't match the code - the command uses --scan_key / --spend_key (src/handlers/descriptor.rs), not --scan_public_key / --spend_public_key.
I have pushed an update to fix this. Thank you. |
Description
The README referenced outdated cargo feature flags
kyotoandsp, which will cause build failures for users following the instructions. This commit updates the documentation to use the correct flagscbfandsilent-paymentsas defined in the currentCargo.toml.Fixes #299
Notes to the reviewers
This is a documentation update to the
README.md. I specifically left the reference toKyotoin the "About" section intact, as it correctly refers to the underlyingbdk_kyotolibrary/concept, and only updated the actual Cargo feature flags in the code blocks and feature lists.Changelog notice
kyoto->cbfandsp->silent-payments) in the README instructions.Checklists
All Submissions:
cargo fmtandcargo clippybefore committingBugfixes: