Skip to content

Commit fd914a1

Browse files
Update package documentation
1 parent 8dd1ecd commit fd914a1

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ Available features include:
2626
1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
2727
2. Supported Flutter version >= 1.17.0
2828
3. Dart SDK >= 2.17.0
29-
4. For Android development, ensure the NDK version >= `27.0.12077973` on your project's `android/app/build.gradle.kts` file with android `{ ndkVersion = "27.0.12077973" }`
29+
4. For Android development, ensure the NDK version >= `27.0.12077973` on your project's `android/app/build.gradle.kts` file with android `{ ndkVersion = "27.0.12077973" }`.
3030

3131
## Installation
3232

33-
1. Add the dependency to your project. In your `pubspec.yaml` file add: `flutterwave_standard: 1.1.1`
34-
2. Run `flutter pub get`
33+
1. Add the dependency to your project. In your `pubspec.yaml` file add: `flutterwave_standard: 1.1.0`
34+
2. Run `flutter pub get`.
3535

3636
## Usage
3737

@@ -90,30 +90,28 @@ Calling the `.charge()` method returns a `Future` of `ChargeResponse` which we a
9090
Call the verify transaction [endpoint](https://developer.flutterwave.com/docs/transaction-verification) with the `transactionID` returned in `response.transactionId` or the `txRef` you provided to verify transaction before offering value to customer
9191

9292
#### Note
93-
9493
- `ChargeResponse` can be null, depending on if the user cancels the transaction by pressing back.
9594
- You need to confirm the transaction status is successful. Ensure that the txRef, amount, and status are correct and successful. Be sure to [verify the transaction details](https://developer.flutterwave.com/docs/transaction-verification) before providing value.
9695
- Some payment methods are not instant, such a `Pay with Bank Transfers, Pay with Bank`, and so you would need to rely on [webhooks](https://developer.flutterwave.com/docs/webhooks) or call the transaction verification service using the [`transactionId`](https://developer.flutterwave.com/reference/verify-transaction), or transaction reference you created(`txRef`)
9796
- For such long payments like the above, closing the payment page returns a `cancelled` status, so your final source of truth has to be calling the transaction verification service.
9897

99-
## Support
10098

99+
## Support
101100
For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).
102101

103102
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
104103

105-
## Contribution guidelines
106104

105+
## Contribution guidelines
107106
Read more about our community contribution guidelines [here](CONTRIBUTING.md).
108107

109-
## License
110108

109+
## License
111110
By contributing to the Flutter library, you agree that your contributions will be licensed under its [MIT license](/LICENSE).
112111

113112
Copyright (c) Flutterwave Inc.
114113

115114
## Built Using
116-
117115
- [flutter](https://flutter.dev/)
118116
- [http](https://pub.dev/packages/http)
119117
- [flutter_inappwebview](https://pub.dev/packages/flutter_inappwebview)
@@ -122,7 +120,6 @@ Copyright (c) Flutterwave Inc.
122120
<a id="references"></a>
123121

124122
## Other Resources
125-
126123
- [Flutterwave API Doc](https://developer.flutterwave.com)
127124
- [Flutterwave Inline Payment Doc](https://developer.flutterwave.com/docs/inline)
128125
- [Flutterwave Dashboard](https://dashboard.flutterwave.com/login)

0 commit comments

Comments
 (0)