0.0.3 released, see CHANGELOG.md

README.md

@@ -3,10 +3,41 @@ A simple and clean Stripe Element Card clone, rebuilt in native Flutter widgets.
 This is not an officially maintained package by Stripe, but using the html stripe
 elements they provide with flutter is less than ideal.
 
+
+
 ## Features
 
-- Card number validation
-- No more depending on Flutter Webview
+Got to use emojis and taglines for attention grabbing and algorithm hacking:
+
+⚡Blazingly fast ( its as fast as the rest of flutter )
+🧹Cleaner ( fewer dependencies than the official stripe elements )
+🛡️Safe and Supports all Flutter Targets ( its native flutter with minimal dependencies )
+☑️Seemless UI/UX ( hard to match stripe quality, but I think I got close )
+🔄Built-in Stripe Integration ( guess that one is obvious )
+☯️Chi Energy Boost ( alright I'm fishing... )
+
+### Why StripeNativeCardField?
+
+- Fewer dependencies: no more depending on Flutter Webview
+- Customizable: the entire field can inherit native Flutter styling, i.e. `BoxDecoration()`
+- Native Implementation: compiles and loads like the rest of your app, unlike embeded html
+- Automatic validation: no `inputFormatters` or `RegExp` needed on your side
+
+The card data can either be retrieved with the `onCardDetailsComplete` callback, or
+you can have the element automatically create a Stripe card token when the fields
+are filled out, and return the token with the `onTokenReceived` callback.
+
+### Mobile
+
+![mobile showcase](./example/loading.gif)
+
+### Desktop
+
+![desktop showcase](./example/loading.gif)
+
+### Customizable
+
+![cumstomization showcase](./example/loading.gif)
 
 ## Getting started
 
@@ -16,10 +47,13 @@ elements they provide with flutter is less than ideal.
 
 Include the package in a file:
 
+
 ```dart
 import 'package:stripe_native_card_field/stripe_native_card_field.dart';
 ```
 
+### For just Card Data
+
 ```dart
 CardTextField(
   width: 500,
@@ -30,6 +64,24 @@ CardTextField(
 );
 ```
 
+### For Stripe Token
+
+```dart
+CardTextField(
+  width: 500,
+  stripePublishableKey: 'pk_test_abc123', // Your stripe key here
+  onTokenReceived: (token) {
+    // Save the stripe token to send to your backend
+    setState(() => _token = token);
+  },
+);
+```
+
+### Cumstomization
+
+For documentation on all of the available customizable aspects of the `CardTextField`, go
+to the [API docs here](https://pub.dev/documentation/stripe_native_card_field/latest/stripe_native_card_field/CardTextField-class.html).
+
 ## Additional information
 
 Repository located [here](https://git.fosscat.com/n8r/stripe_native_card_field)