You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ContextSDK is a powerful tool that brings real-world context and insights directly into your Flutter app through on-device signals, empowering you to boost conversions and engagement, enhance user experiences, and reduce churn — all with privacy in mind, as no personally identifiable information (PII) is ever collected.
10
10
11
-
## Supported Platforms
11
+
Our SDK supports iOS and will soon support Android, making it easy to integrate into your cross-platform Flutter projects.
12
12
13
-
- iOS - 14.0 and higher
14
-
- Android - Coming Soon
13
+
## Getting Started
15
14
16
-
## Overview
15
+
This repository is dedicated to managing releases of ContextSDK for Flutter, distributed via [pub.dev](https://pub.dev/packages/context_sdk). For other platforms, such as Swift and Android, or alternative installation methods like CocoaPods, please see our [official documentation](https://docs.decision.contextsdk.com/).
17
16
18
-
Follow these steps to add ContextSDK to your app, and refer to the [official documentation](https://docs.decision.contextsdk.com/) for additional details and advanced configuration.
17
+
To integrate ContextSDK into your Flutter project, follow these steps:
19
18
20
-
-**Step 1**: Add ContextSDK to your app
21
-
-**Step 2**: Track conversion events
22
-
-**Step 3**: Ship an App Store update with ContextSDK
19
+
### Installation
23
20
24
-
## Installation
21
+
1. Add `context_sdk` to your `pubspec.yaml` file:
25
22
26
-
**Step 1:** Add `context_sdk` to your `pubspec.yaml`
27
-
28
-
**Step 2:** Ensure minimum Deployment Target
23
+
```yaml
24
+
dependencies:
25
+
context_sdk: ^latest_version
26
+
```
29
27
30
-
ContextSDK requires a minimum deployment target of iOS 14.0, be sure to update your `ios/Podfile` to specify 14.0 or higher:
28
+
2. Ensure the minimum deployment target for iOS is set to `14.0` or higher in your `ios/Podfile`:
31
29
32
30
```ruby
33
31
platform :ios, '14.0'
34
32
```
35
33
36
-
### Activating ContextSDK
34
+
### Setup
37
35
38
-
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.
36
+
After installing ContextSDK, initialize it with your license key at app startup. You can [sign up here](https://console.contextsdk.com/register) to receive your license key.
39
37
40
38
```dart
41
39
import 'package:context_sdk/context_sdk.dart';
@@ -45,23 +43,39 @@ final _contextSdkPlugin = ContextSdk();
45
43
_contextSdkPlugin.setup("YOUR_LICENSE_KEY_HERE");
46
44
```
47
45
48
-
## Track conversion Events
46
+
## Using ContextSDK
47
+
48
+
### Tracking Conversion Events
49
49
50
-
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/)
50
+
To maximize the value of ContextSDK, ensure you log data for all upsell prompts or other critical events. Here’s an example:
51
51
52
52
```dart
53
53
import 'package:context_sdk/context_sdk.dart';
54
54
55
55
final _contextSdkPlugin = ContextSdk();
56
56
57
-
// Make sure to call this immediately before showing the prompt to the user.
57
+
// Call this immediately before showing the prompt to the user.
// Show the upgrade prompt here right after fetching the context
60
-
// Once you know if the user purchased or dismissed the upsell, log the outcome:
61
-
context.log(Outcome.positive);
59
+
// Display the upgrade prompt here after fetching the context
60
+
// Log the outcome after user interaction:
61
+
context.log(Outcome.positive); // or Outcome.negative
62
62
});
63
63
```
64
64
65
-
## Go Live
65
+
### Going Live
66
+
67
+
Once integrated, you're ready to ship your app update to the App Store and start leveraging real-world 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.
68
+
69
+
## Documentation
70
+
71
+
For detailed setup instructions, usage examples, and advanced usage scenarios, visit our [official documentation](https://docs.decision.contextsdk.com/).
72
+
73
+
## Not using ContextSDK yet?
74
+
75
+
If you’re interested in adding real-world context insights to your app, you can [sign up here](https://console.contextsdk.com/register) to receive your license key and access. For more information about how ContextSDK can enhance your app’s user experience, visit our [website](https://contextsdk.com) or reach out to our team at [email protected].
76
+
77
+
## Support
78
+
79
+
For any questions or technical support, please don’t hesitate to reach out to our team — we’re eager to help!
66
80
67
-
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.
81
+
Thank you for choosing ContextSDK! 🚀 We’re excited to support you in building context-aware experiences for your users.
0 commit comments