From 71c42b0b34b66dc75c1dd0bd2db3464802f79683 Mon Sep 17 00:00:00 2001 From: Erdem Yerebasmaz Date: Fri, 3 May 2024 16:04:11 +0300 Subject: [PATCH] Update README and remove TODO --- lib/bindings/bindings-flutter/README.md | 19 +++++++++++-------- lib/bindings/bindings-flutter/TODO.md | 4 ---- 2 files changed, 11 insertions(+), 12 deletions(-) delete mode 100644 lib/bindings/bindings-flutter/TODO.md diff --git a/lib/bindings/bindings-flutter/README.md b/lib/bindings/bindings-flutter/README.md index 4c91028..e601411 100644 --- a/lib/bindings/bindings-flutter/README.md +++ b/lib/bindings/bindings-flutter/README.md @@ -1,15 +1,18 @@ -# breez_liquid +# breez_liquid_sdk_workspace +Binding generation & build scripts for Dart/Flutter packages of Breez Liquid SDK. -```dart -import 'package:breez_liquid/breez_liquid.dart'; +Prerequisites: +- [just](https://github.com/casey/just) command runner. +- [Melos](https://github.com/invertase/melos) CLI tool. -final bl = BreezLiquidImpl(dylib); ``` - -## Contributing - -Closing issues in [TODO.md](TODO.md) will help make this project grow! +just clean +just init +just gen +just link +just build +``` ## License diff --git a/lib/bindings/bindings-flutter/TODO.md b/lib/bindings/bindings-flutter/TODO.md deleted file mode 100644 index e022129..0000000 --- a/lib/bindings/bindings-flutter/TODO.md +++ /dev/null @@ -1,4 +0,0 @@ -# Todos (non-exhaustive) - -- [x] Only compile core with build commands -- [] Move Dart/Flutter packages to `./packages/dart` & `./packages/flutter` \ No newline at end of file