From: rajarshimaitra Date: Tue, 4 Jan 2022 14:12:17 +0000 (+0530) Subject: Add introduction for bdk-cli X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/sent.html?a=commitdiff_plain;h=870cb22db6313908651817819e3da93522883d9c;p=bitcoindevkit.org Add introduction for bdk-cli --- diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 2d302fb9a4..a9094f9ccf 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -18,6 +18,7 @@ const docsSidebar = [ title: "BDK-CLI", collapsable: true, children: [ + '/bdk-cli/introduction', '/bdk-cli/installation', '/bdk-cli/concept', '/bdk-cli/interface', diff --git a/docs/bdk-cli/introduction.md b/docs/bdk-cli/introduction.md new file mode 100644 index 0000000000..7a7357341b --- /dev/null +++ b/docs/bdk-cli/introduction.md @@ -0,0 +1,13 @@ +# Introduction + +[`bdk-cli`](https://github.com/bitcoindevkit/bdk-cli) is a lightweight [`repl`](https://codewith.mu/en/tutorials/1.0/repl) wrapper over `bdk` that comes as a command line application. It is useful for quick testing and prototyping of bdk functionalities. + +This can also be used as an example application to create your own command line bitcoin wallet tool using bdk. + +`bdk-cli` can interface with all the blockchain backends currently supported by `bdk`, like `rpc`, `electrum`, `esplora` and `compact_filters`. + + + +Check out [project documentation](https://docs.rs/bdk-cli/0.3.0/bdk_cli/) for more details. + +The following sections goes into more details on the installation and usage of `bdk-cli`. \ No newline at end of file