From: Vihiga Tyonum <withtvpeter@gmail.com>
Date: Fri, 30 May 2025 20:52:39 +0000 (+0100)
Subject: chore(add-justfile): update README
X-Git-Tag: v2.0.0~10^2
X-Git-Url: http://internal-gitweb-vhost/bitcoin/struct.Script.html?a=commitdiff_plain;h=98bef7ec55f421f7ae172fcfccd25725ad87486f;p=bdk-cli

chore(add-justfile): update README

- update readme to include just command runner
---

diff --git a/README.md b/README.md
index 5df6a57..1c7d5f7 100644
--- a/README.md
+++ b/README.md
@@ -113,6 +113,21 @@ To generate a new extended master key, suitable for use in a descriptor:
 cargo run -- key generate
 ```
 
+## Justfile
+
+We have added the `just` command runner to help you with common commands (during development) and running regtest `bitcoind` if you are using the `rpc` feature. 
+Visit the [just](https://just.systems/man/en/packages.html) page for setup instructions.
+
+The below are some of the commands included:
+
+``` shell
+just # list all available recipes
+just start # start regtest bitcoind in default dir
+just test # test the project
+just build # build the project
+```
+
+
 ## Minimum Supported Rust Version (MSRV)
 
 This library should always compile with any valid combination of features on Rust **1.75.0**.