Skip to content

Commit 08094fb

Browse files
committed
Add Dart ffi README
1 parent 03c0316 commit 08094fb

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

payjoin-ffi/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The directories below include instructions for using, building, and publishing t
1313
| Language | Platform | Repository | Published Package |
1414
|----------|-----------------------|-------------------|------------------------------------|
1515
| Python | linux, macOS | [payjoin-ffi/python](python) | [payjoin](https://pypi.org/project/payjoin/) |
16+
| Dart | linux, macOS | [payjoin-ffi/dart](dart) | N/A |
1617

1718
## Minimum Supported Rust Version (MSRV)
1819

payjoin-ffi/dart/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Payjoin Dart Bindings
2+
3+
Welcome to the Dart language bindings for the [Payjoin Dev Kit](https://payjoindevkit.org/)!
4+
5+
## Running Tests
6+
7+
Follow these steps to clone the repository and run the tests.
8+
9+
10+
```shell
11+
git clone https://github.com/payjoin/rust-payjoin.git
12+
cd rust-payjoin/payjoin-ffi/dart
13+
14+
# Install dependencies
15+
dart pub get
16+
17+
# Generate the bindings (use the script appropriate for your platform)
18+
bash ./scripts/generate_<platform>.sh
19+
20+
# Run all tests
21+
dart test
22+
```
23+
24+
Note that you'll need Docker to run the integration tests. If you get a "Failed to start container" error, ensure the Docker engine is running on your machine.

0 commit comments

Comments
 (0)