Merge pull request #1 from context-sdk/reinhard/pre-release

chore: Small changes before publishing

Author: KrauseFx

CHANGELOG.md

@@ -0,0 +1,5 @@
+# context_sd Changelog
+
+**[Android] 1.0.0 - 2024-10-01**
+
+- Initial Release

README.md

@@ -1,4 +1,59 @@
 # context_sdk
 
-A Flutter plugin to expose the iOS ContextSDK Framework to Flutter applications.
+ContextSDK for Flutter
 
+## Supported Platforms
+
+- iOS - 14.0 and higher
+- Android - Coming Soon
+
+## Overview
+
+- **Step 1**: Add ContextSDK to your app
+- **Step 2**: Track conversion events
+- **Step 3**: Ship an App Store update with ContextSDK
+
+## Installation
+
+**Step 1:** Add `context_sdk` to your `pubspec.yaml`
+
+**Step 2:** Ensure minimum Deployment Target
+
+ContextSDK requires a minimum deployment target of iOS 14.0, be sure to update your `ios/Podfile` to specify 14.0 or higher:
+
+```ruby
+platform :ios, '14.0'
+```
+
+### Activating ContextSDK
+
+After you installed ContextSDK, you need to add your license key. [Register here](https://console.contextsdk.com/register) to get started. Call this on app start.
+
+```dart
+import 'package:context_sdk/context_sdk.dart';
+
+final _contextSdkPlugin = ContextSdk();
+
+_contextSdkPlugin.setup("YOUR_LICENSE_KEY_HERE");
+```
+
+## Track conversion Events
+
+To get the most use out of ContextSDK make sure to log data for all your upsell prompts. For more details check out the [documentation](https://docs.insights.contextsdk.com/)
+
+```dart
+import 'package:context_sdk/context_sdk.dart';
+
+final _contextSdkPlugin = ContextSdk();
+
+// Make sure to call this immediately before showing the prompt to the user.
+_contextSdkPlugin.optimize("upsell", null, null, (context) async {
+  // Show the upgrade prompt here right after fetching the context
+  // Once you know if the user purchased or dismissed the upsell, log the outcome:
+  context.log(Outcome.positive);
+});
+```
+
+## Go Live
+
+Now all that's left is to ship your update to the App Store to start gaining context insights. Continue to the [release page](https://docs.insights.contextsdk.com/release/) for a final check before shipping, as well as other deployment tips.

example/integration_test/plugin_integration_test.dart

@@ -102,7 +102,7 @@ class _MyAppState extends State<MyApp> {
                 child: const Text('Track User Action')),
                 ElevatedButton(
                 onPressed: () async => {
-                       _contextSdkPlugin.calibrate("my_flow", 4, {
+                       _contextSdkPlugin.calibrate("my_flow", null, {
                         'string': 'string',
                         'int': 14,
                         'bool': true,
@@ -121,7 +121,7 @@ class _MyAppState extends State<MyApp> {
                 child: const Text('Calibrate')),
                 ElevatedButton(
                 onPressed: () async => {
-                       _contextSdkPlugin.optimize("my_flow", 4, {
+                       _contextSdkPlugin.optimize("my_flow", null, {
                         'string': 'string',
                         'int': 14,
                         'bool': true,
@@ -140,7 +140,7 @@ class _MyAppState extends State<MyApp> {
                 child: const Text('Optimize')),
                 ElevatedButton(
                 onPressed: () async => {
-                       _contextSdkPlugin.fetchContext("my_flow", 4, {
+                       _contextSdkPlugin.fetchContext("my_flow", 3, {
                         'string': 'string',
                         'int': 14,
                         'bool': true,
@@ -159,7 +159,7 @@ class _MyAppState extends State<MyApp> {
                 child: const Text('Fetch Context')),
                 ElevatedButton(
                 onPressed: () async => {
-                       _contextSdkPlugin.fetchContext("my_flow", 4, {
+                       _contextSdkPlugin.fetchContext("my_flow", 3, {
                         'string': 'string',
                         'int': 14,
                         'bool': true,

example/lib/main.dart

@@ -26,5 +26,5 @@ A Flutter plugin for ContextSDK.
   # plugin's privacy impact, and then uncomment this line. For more information,
   # see https://developer.apple.com/documentation/bundleresources/privacy_manifest_files
   s.resource_bundles = {'context_sdk_privacy' => ['Resources/PrivacyInfo.xcprivacy']}
-  s.dependency("ContextSDK", '4.5.1')
+  s.dependency("ContextSDK", '4.6.0')
 end

example/test/widget_test.dart

@@ -1,6 +1,6 @@
 import 'package:context_sdk/context_sdk_platform_interface.dart';
 
-/// /// Represents a full context event in a moment in time. Use [RealWorldContext.log] to log an event.
+/// Represents a full context event in a moment in time. Use [RealWorldContext.log] to log an event.
 class RealWorldContext {
   // Keeps the finalizer itself reachable, otherwise it might be disposed
   // before the finalizer callback gets a chance to run.