Skip to content

Commit 65b0c11

Browse files
Copilot0xrinegade
andcommitted
Complete Flutter SDK integration with updated documentation
Co-authored-by: 0xrinegade <[email protected]>
1 parent 8374ecd commit 65b0c11

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

mobile/README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,67 @@
11
# SVM-Pay Mobile SDK Build Configuration
22

3-
This directory contains the build configuration for the SVM-Pay mobile SDKs for iOS and Android.
3+
This directory contains the build configuration for the SVM-Pay mobile SDKs for iOS, Android, and Flutter.
4+
5+
## Flutter SDK 🎯
6+
7+
The Flutter SDK provides cross-platform support for both iOS and Android with a single codebase.
8+
9+
### Requirements
10+
11+
- Flutter 3.3.0 or later
12+
- Dart 3.8.1 or later
13+
- iOS 13.0 or later (for iOS builds)
14+
- Android API level 21 or later (for Android builds)
15+
16+
### Installation
17+
18+
Add to your `pubspec.yaml`:
19+
20+
```yaml
21+
dependencies:
22+
svm_pay: ^1.1.0
23+
```
24+
25+
### Quick Start
26+
27+
```dart
28+
import 'package:svm_pay/svm_pay.dart';
29+
30+
final svmPay = SVMPay(
31+
config: const SVMPayConfig(
32+
defaultNetwork: SVMNetwork.solana,
33+
debug: true,
34+
),
35+
);
36+
37+
// Use payment widgets
38+
PaymentButton(
39+
recipient: 'recipient_address',
40+
amount: '1.0',
41+
onPayment: (result) async {
42+
// Handle payment result
43+
},
44+
)
45+
```
46+
47+
### Building from Source
48+
49+
The Flutter SDK is included in this repository at `flutter_sdk/`.
50+
51+
```bash
52+
cd flutter_sdk
53+
flutter pub get
54+
flutter test
55+
```
56+
57+
To run the example app:
58+
59+
```bash
60+
cd flutter_sdk/example
61+
flutter run
62+
```
63+
64+
For complete documentation, see [Flutter SDK README](../flutter_sdk/README.md).
465

566
## iOS SDK
667

@@ -92,4 +153,8 @@ cd svm-pay-android
92153

93154
## Documentation
94155

95-
For detailed documentation on how to use the mobile SDKs, please refer to the [SVM-Pay Documentation](../docs/documentation.md#mobile-sdk).
156+
For detailed documentation on how to use the mobile SDKs, please refer to:
157+
158+
- [Flutter SDK Documentation](../flutter_sdk/README.md)
159+
- [SVM-Pay Documentation](../docs/documentation.md#mobile-sdk)
160+
- [Main Project README](../README.md)

0 commit comments

Comments
 (0)