@growth-rail/react 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# @growth-rail/react
+
+## 2.0.2
+
+### Patch Changes
+
+- added read me
+- Updated dependencies
+  - @growth-rail/core@2.0.1
+
+## 2.0.1
+
+### Patch Changes
+
+- dependency fixed
+
+## 2.0.0
+
+### Major Changes
+
+- option type changes
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [d4cc14b]
+  - @growth-rail/core@2.0.0
+
+## 1.0.0
+
+### Major Changes
+
+- Initial SDK Version
+
+### Patch Changes
+
+- Updated dependencies
+  - @growth-rail/core@1.0.0

package/README.md

@@ -0,0 +1,94 @@
+# @growth-rail/react
+
+The Official Growth Rail React SDK. Easily integrate referral programs, track user growth, and display referral dashboards in your React applications.
+
+## 🚀 Features
+
+-   **Context-based Initialization**: Seamless setup with `GrowthRailProvider`.
+-   **Hooks for Ease of Use**: Access the SDK anywhere with the `useGrowthRail` hook.
+-   **Built-in UI Components**: Drop-in widgets like `ReferralDashboard` to get started instantly.
+-   **Fully Type-Safe**: Written in TypeScript with complete definition support.
+-   **Small Footprint**: Optimized for performance and minimal bundle size.
+
+## 📦 Installation
+
+This package requires `@growth-rail/core` as a dependency and `react` as a peer dependency.
+
+```bash
+# npm
+npm install @growth-rail/react @growth-rail/core
+
+# yarn
+yarn add @growth-rail/react @growth-rail/core
+
+# pnpm
+pnpm add @growth-rail/react @growth-rail/core
+```
+
+## 🛠 Usage
+
+### 1. Wrap your App with `GrowthRailProvider`
+
+Initialize the SDK at the root of your application. Provide your API Key and optionally a `userId` if the user is already authenticated.
+
+```tsx
+import { GrowthRailProvider } from '@growth-rail/react';
+
+function App() {
+  return (
+    <GrowthRailProvider 
+      apiKey="your_api_key_here" 
+      userId="user_123" // Optional: initialize for a specific user
+    >
+      <your-application-code />
+    </GrowthRailProvider>
+  );
+}
+```
+
+### 2. Track Events and Get User Info
+
+Use the `useGrowthRail` hook in any child component to track referrals or retrieve user details.
+
+```tsx
+import { useGrowthRail } from '@growth-rail/react';
+
+export function InviteButton() {
+  const { trackReferral, getUserId } = useGrowthRail();
+
+  const handleInvite = async (code: string) => {
+    await trackReferral(code);
+    console.log('Referral tracked for user:', getUserId());
+  };
+
+  return <button onClick={() => handleInvite('FRIEND_CODE')}>Use Invite</button>;
+}
+```
+
+### 3. Display the Referral Dashboard
+
+Use the `ReferralDashboard` component to provide a white-labeled UI where users can see their referral link and rewards.
+
+```tsx
+import { ReferralDashboard } from '@growth-rail/react';
+
+export function DashboardPage() {
+  return (
+    <div style={{ padding: '20px' }}>
+      <h1>My Rewards</h1>
+      <ReferralDashboard 
+        title="Invite your friends and earn!" 
+        onLinkCopied={() => alert('Link copied!')}
+      />
+    </div>
+  );
+}
+```
+
+## 📖 Documentation
+
+For full documentation and advanced configuration, visit [docs.growthrail.com](https://docs.growthrail.com).
+
+## 📄 License
+
+MIT © [Growth Rail](https://growthrail.com)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@growth-rail/react",
-    "version": "2.0.1",
+    "version": "2.0.2",
     "description": "Growth Rail React SDK",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",
@@ -13,7 +13,9 @@
         }
     },
     "files": [
-        "dist"
+        "dist",
+        "README.md",
+        "CHANGELOG.md"
     ],
     "scripts": {
         "build": "tsup",
@@ -27,7 +29,7 @@
         "react-dom": ">=16.8"
     },
     "dependencies": {
-        "@growth-rail/core": "^2.0.0"
+        "@growth-rail/core": "^2.0.1"
     },
     "devDependencies": {
         "@growth-rail/eslint-config": "*",
@@ -45,4 +47,4 @@
     "publishConfig": {
         "access": "public"
     }
-}
+}