Skip to content

Commit ecba28c

Browse files
committed
docs: Add how to run example files to readme
1 parent 6fc5b48 commit ecba28c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

bdk-jvm/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,19 @@ sdk install java 17.0.2-tem
4949
bash ./scripts/build-<your-local-architecture>.sh
5050
```
5151

52+
## Run example files
53+
The `examples` module show different samples of how some of the APIs can be used. You can run the examples after building as stated above. The gradle task to run is by convention the file name of the example file.
54+
55+
```shell
56+
cd bdk-jvm
57+
./gradlew MultisigTransaction
58+
```
59+
60+
You can also list the application tasks. (All examples grouped under application)
61+
```shell
62+
cd bdk-jvm
63+
./gradlew tasks --group application
64+
```
5265
## How to publish to your local Maven repo
5366

5467
```shell

0 commit comments

Comments
 (0)