Skip to content

docs: update cargo features in README to match Cargo.toml#300

Merged
tvpeter merged 2 commits into
bitcoindevkit:masterfrom
Musab1258:docs/readme-cargo-features
Jul 11, 2026
Merged

docs: update cargo features in README to match Cargo.toml#300
tvpeter merged 2 commits into
bitcoindevkit:masterfrom
Musab1258:docs/readme-cargo-features

Conversation

@Musab1258

Copy link
Copy Markdown
Contributor

Description

The README referenced outdated cargo feature flags kyoto and sp, which will cause 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.

Fixes #299

Notes to the reviewers

This is a documentation update to the README.md. I specifically left the reference to Kyoto in the "About" section intact, as it correctly refers to the underlying bdk_kyoto library/concept, and only updated the actual Cargo feature flags in the code blocks and feature lists.

Changelog notice

  • Fixed outdated cargo feature flags (kyoto -> cbf and sp -> silent-payments) in the README instructions.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

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.
@Musab1258

Copy link
Copy Markdown
Contributor Author

Hi @tvpeter, can you please check this out?

@codecov

codecov Bot commented Jul 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.89%. Comparing base (6000dd5) to head (047bbbe).
⚠️ Report is 1 commits behind head on master.

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           
Flag Coverage Δ
rust 56.89% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tvpeter tvpeter left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 4a1ff1b

@tvpeter tvpeter added the documentation Improvements or additions to documentation label Jul 10, 2026
@tvpeter tvpeter added this to the CLI 4.0.0 milestone Jul 10, 2026

@va-an va-an left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@tvpeter

tvpeter commented Jul 11, 2026

Copy link
Copy Markdown
Collaborator

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.

@tvpeter tvpeter merged commit 9b58a1a into bitcoindevkit:master Jul 11, 2026
9 checks passed
@github-project-automation github-project-automation Bot moved this to Done in BDK-CLI Jul 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Docs: Outdated Cargo features in README

3 participants