]> Untitled Git - bitcoindevkit.org/commitdiff
Add introduction for bdk-cli
authorrajarshimaitra <rajarshi149@gmail.com>
Tue, 4 Jan 2022 14:12:17 +0000 (19:42 +0530)
committerrajarshimaitra <rajarshi149@gmail.com>
Wed, 9 Mar 2022 14:49:52 +0000 (20:19 +0530)
docs/.vuepress/config.js
docs/bdk-cli/introduction.md [new file with mode: 0644]

index 2d302fb9a4d68750f08069992ec2a97c686b6247..a9094f9ccfdbacfaa42e159d4aacc435b2a7be7a 100644 (file)
@@ -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 (file)
index 0000000..7a73573
--- /dev/null
@@ -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`.
+
+<!-- `bdk-cli` comes with `regtest-*` features that can automatically deploy a regtest backend with a connected `bdk` wallet in background. This can be useful If you don't want to setup your own regtest node or try out quick tests, especially in `repl` mode. -->
+
+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