Skip to content

Commit 023b9b4

Browse files
authored
#6 Update README with more info about us
2 parents bde1db6 + 25c1cd4 commit 023b9b4

File tree

1 file changed

+39
-25
lines changed

1 file changed

+39
-25
lines changed

README.md

+39-25
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,39 @@
1-
# context_sdk
1+
# ContextSDK for Flutter
22

33
[![pub version](https://img.shields.io/pub/v/context_sdk)](https://pub.dev/packages/context_sdk)
44
[![Changelog](https://img.shields.io/badge/changelog-latest-blue)](https://docs.decision.contextsdk.com/changelog/)
55
[![Documentation](https://img.shields.io/badge/documentation-latest-blue)](https://docs.decision.contextsdk.com/)
66
[![Issues](https://img.shields.io/github/issues/context-sdk/flutter)](https://github.com/context-sdk/flutter/issues)
77
[![Pull Requests](https://img.shields.io/github/issues-pr/context-sdk/flutter)](https://github.com/context-sdk/flutter/pulls)
88

9-
ContextSDK for Flutter
9+
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.
1010

11-
## Supported Platforms
11+
Our SDK supports iOS and will soon support Android, making it easy to integrate into your cross-platform Flutter projects.
1212

13-
- iOS - 14.0 and higher
14-
- Android - Coming Soon
13+
## Getting Started
1514

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/).
1716

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:
1918

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
2320

24-
## Installation
21+
1. Add `context_sdk` to your `pubspec.yaml` file:
2522

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+
```
2927
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`:
3129

3230
```ruby
3331
platform :ios, '14.0'
3432
```
3533

36-
### Activating ContextSDK
34+
### Setup
3735

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.
3937

4038
```dart
4139
import 'package:context_sdk/context_sdk.dart';
@@ -45,23 +43,39 @@ final _contextSdkPlugin = ContextSdk();
4543
_contextSdkPlugin.setup("YOUR_LICENSE_KEY_HERE");
4644
```
4745

48-
## Track conversion Events
46+
## Using ContextSDK
47+
48+
### Tracking Conversion Events
4949

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:
5151

5252
```dart
5353
import 'package:context_sdk/context_sdk.dart';
5454
5555
final _contextSdkPlugin = ContextSdk();
5656
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.
5858
_contextSdkPlugin.optimize("upsell", null, null, (context) async {
59-
// 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
6262
});
6363
```
6464

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!
6680

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

Comments
 (0)