@growth-rail/react-native 0.0.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @growth-rail/react-native
 
+## 1.0.0
+
+### Major Changes
+
+- React Native SDK implementation
+
 ## 0.0.0
 
 - Initial release of the React Native SDK.

package/README.md

@@ -1,15 +1,168 @@
 # @growth-rail/react-native
 
-Growth Rail SDK for React Native.
+The GrowthRail React Native SDK provides a seamless way to integrate referral programs into your React Native applications. It handles multi-platform deep linking, user attribution, and displays premium UI components for referral dashboards and banners.
+
+## Features
+
+- 🚀 **One-Tap Integration**: Wrap your app with `GrowthRailProvider` to get started.
+- 🔗 **Deep Linking**: Built-in support for attribution via standard and deferred deep links.
+- 🎨 **Premium UI**: Ready-made components for Referral Dashboards and Reward Banners.
+- 📱 **Cross-Platform**: Consistent behavior across iOS and Android.
+- ⚡ **Lightweight**: Optimized for performance with minimal dependencies.
 
 ## Installation
 
 ```bash
-npm install @growth-rail/react-native
+yarn add @growth-rail/react-native @react-native-async-storage/async-storage react-native-play-install-referrer
 # or
-yarn add @growth-rail/react-native
+npm install @growth-rail/react-native @react-native-async-storage/async-storage react-native-play-install-referrer
+```
+
+> **Note**: For iOS, remember to run `cd ios && pod install`.
+
+## Setup
+
+### 1. Initialize the Provider
+
+Wrap your main application component with `GrowthRailProvider`. This handles SDK initialization and provides the context for UI components.
+
+```tsx
+import { GrowthRailProvider } from '@growth-rail/react-native';
+
+const App = () => {
+  return (
+    <GrowthRailProvider 
+      apiKey="YOUR_API_KEY"
+      userId="USER_UNIQUE_ID" // optional at start
+    >
+      <YourAppContent />
+    </GrowthRailProvider>
+  );
+};
+```
+
+### 2. Deep Link Configuration
+
+#### iOS (AppDelegate.mm)
+Ensure your app handles deep links by adding the following to your `AppDelegate`:
+
+```objectivec
+#import <React/RCTLinkingManager.h>
+
+- (BOOL)application:(UIApplication *)application
+   openURL:(NSURL *)url
+   options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
+{
+  return [RCTLinkingManager application:application openURL:url options:options];
+}
+```
+
+#### Android (AndroidManifest.xml)
+Add an intent filter for your deep link scheme:
+
+```xml
+<intent-filter>
+    <action android:name="android.intent.action.VIEW" />
+    <category android:name="android.intent.category.DEFAULT" />
+    <category android:name="android.intent.category.BROWSABLE" />
+    <data android:scheme="your-app-scheme" />
+</intent-filter>
 ```
 
 ## Usage
 
-Please refer to the documentation for usage instructions.
+### User Initialization
+If you didn't provide a `userId` to the provider, or if the user logs in later:
+
+```tsx
+import { GrowthRail } from '@growth-rail/react-native';
+
+const handleLogin = async (user) => {
+  await GrowthRail.initAppUser(user.id);
+};
+```
+
+### Tracking Reward Events
+Attribute successful actions (like purchases or sign-ups) to the referrer:
+
+```tsx
+import { GrowthRail } from '@growth-rail/react-native';
+
+const onPurchaseComplete = async () => {
+  await GrowthRail.trackRewardEvent('purchase_completed');
+};
+```
+
+### Using the `useGrowthRail` Hook
+For more control and to access loading/error states in your components:
+
+```tsx
+import { useGrowthRail } from '@growth-rail/react-native';
+
+const MyComponent = () => {
+  const { 
+    initUser, 
+    trackReward, 
+    showReferralDashboard, 
+    isLoading, 
+    error 
+  } = useGrowthRail();
+
+  const handleAction = async () => {
+    await trackReward('custom_action');
+  };
+
+  return (
+    <View>
+      <Button title="Open Referrals" onPress={() => showReferralDashboard()} />
+      {isLoading && <ActivityIndicator />}
+    </View>
+  );
+};
+```
+
+### Referral Dashboard
+Display a beautiful, pre-built dashboard for users to manage their referrals.
+
+```tsx
+import { useGrowthRailContext } from '@growth-rail/react-native';
+
+const MyProfile = () => {
+  const { showDashboard } = useGrowthRailContext();
+
+  return (
+      <Button title="Refer & Earn" onPress={() => showDashboard()} />
+  );
+};
+```
+
+### Generating Referral Links Manually
+If you need to build a custom UI, you can generate the referral link directly:
+
+```tsx
+import { GrowthRail } from '@growth-rail/react-native';
+
+const getLink = async () => {
+  const { referralLink } = await GrowthRail.createReferralLink();
+  console.log('Share this link:', referralLink);
+};
+```
+
+## API Reference
+
+### `GrowthRailProvider` Props
+| Prop | Type | Description |
+| :--- | :--- | :--- |
+| `apiKey` | `string` | Your GrowthRail API Key. |
+| `userId` | `string` | (Optional) The current user's unique ID. |
+| `apiUrl` | `string` | (Optional) Custom API endpoint. |
+
+### `useGrowthRailContext()`
+Provides access to SDK methods:
+- `showDashboard()`: Opens the referral dashboard.
+- `hideDashboard()`: Closes the referral dashboard.
+- `showFloatingButton()`: Shows/hides the floating trigger.
+- `isInitialized`: Boolean indicating if the SDK is ready.
+
+## License
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@growth-rail/react-native",
-    "version": "0.0.0",
+    "version": "1.0.0",
     "description": "Growth Rail SDK for React Native",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",