Skip to content

Update installation and interface guide of CLI#109

Merged
notmandatory merged 1 commit intobitcoindevkit:masterfrom
vladimirfomene:update-bdk-cli-docs
Sep 1, 2022
Merged

Update installation and interface guide of CLI#109
notmandatory merged 1 commit intobitcoindevkit:masterfrom
vladimirfomene:update-bdk-cli-docs

Conversation

@vladimirfomene
Copy link
Copy Markdown
Contributor

Update the instructions in the guide to follow the latest version of the CLI. Remove some information duplication and typos.

@notmandatory, I removed the language specification on the bash command outputs because it will try to highlight anything in the output that looks like code. Like the angle brackets in the sign output below:
sign-output

@netlify
Copy link
Copy Markdown

netlify Bot commented Jul 15, 2022

Deploy Preview for awesome-golick-685c88 ready!

Name Link
🔨 Latest commit ffcab9e
🔍 Latest deploy log https://app.netlify.com/sites/awesome-golick-685c88/deploys/63109322a1cdde0009a2bd0c
😎 Deploy Preview https://deploy-preview-109--awesome-golick-685c88.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Copy Markdown
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

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

I left a few small suggestions but overall this looks good. Thanks for the overdue refresh for this section.

Comment thread docs/bdk-cli/installation.md Outdated
Comment thread docs/bdk-cli/installation.md
Comment thread docs/bdk-cli/interface.md Outdated
Copy link
Copy Markdown
Contributor

@rajarshimaitra rajarshimaitra left a comment

Choose a reason for hiding this comment

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

ACK 03c8212

Thanks for covering this.. This is compatible with remaining of the pending updates in bdk-cli too.. So its good to go..

Just one small thing that we should also update with this..

Line 20: At the time of writing, the project requires cargo >= 1.46.0, which is our minimum supported rust version (MSRV) as of July 2021. If you have an older version installed with rustup.rs, you can upgrade it with rustup update.

This can be updated now.. Our MSRV in v0.5.0 is 1.56.

@vladimirfomene
Copy link
Copy Markdown
Contributor Author

@rajarshimaitra, changed the MSRV to 1.56.0 as recommended

Comment thread docs/bdk-cli/installation.md Outdated
Copy link
Copy Markdown
Contributor

@rajarshimaitra rajarshimaitra left a comment

Choose a reason for hiding this comment

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

Thanks for the update.. This looks good to me now.. Just few more nits here and there..

Comment thread docs/bdk-cli/interface.md
Comment thread docs/bdk-cli/interface.md Outdated
Comment thread docs/bdk-cli/interface.md Outdated
Comment thread docs/bdk-cli/interface.md Outdated
Update the instructions in the guide to follow
the latest version of the CLI. Remove some
information duplication and typos.
Copy link
Copy Markdown
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

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

ACK ffcab9e

Looks good to me.

@notmandatory notmandatory merged commit d47c16e into bitcoindevkit:master Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants