@li-nk.me/react-native-sdk 0.1.1 → 0.2.0

package/README.md

@@ -1,103 +1,30 @@
 # LinkMe React Native SDK
 
-Pure TypeScript React Native SDK for LinkMe — deep linking and attribution. No native modules required.
+React Native SDK for LinkMe — deep linking and attribution.
 
-- Quick Start: See `QUICK_START.md`
-- Repo docs: ../../docs/help/docs/setup/react-native.md
-- Hosted docs: https://li-nk.me/resources/developer/setup/react-native
-- Example app: See `example-expo/` directory
-- Android troubleshooting: See [Android Troubleshooting](https://li-nk.me/resources/developer/setup/android#troubleshooting) section in Android setup docs
+- **Main Site**: [li-nk.me](https://li-nk.me)
+- **Documentation**: [React Native Setup](https://li-nk.me/docs/developer/setup/react-native)
+- **Package**: [npm](https://www.npmjs.com/package/@linkme/react-native-sdk)
 
 ## Installation
 
 ```bash
-npm install @li-nk.me/react-native-sdk
+npm install @linkme/react-native-sdk
 ```
 
-### Optional: iOS Pasteboard Support
+## Basic Usage
 
-For more reliable deferred deep linking on iOS, install `expo-clipboard`:
+```ts
+import { configure } from '@linkme/react-native-sdk';
 
-```bash
-npx expo install expo-clipboard
-```
-
-When installed, the SDK will automatically check the iOS pasteboard for a li-nk.me URL before falling back to fingerprint matching. Pasteboard must also be enabled in the Portal (App Settings → iOS).
-
-### Expo Configuration
-
-Add the config plugin to your `app.json` or `app.config.js`:
-
-```json
-{
-  "expo": {
-    "plugins": [
-      [
-        "@li-nk.me/react-native-sdk/plugin/app.plugin.js",
-        {
-          "hosts": ["link.example.com"],
-          "associatedDomains": ["applinks:link.example.com"],
-          "schemes": ["com.example.app"]
-        }
-      ]
-    ]
-  }
-}
-```
-
-## Usage
-
-Initialize the SDK in your root layout (e.g., `app/_layout.tsx`):
-
-```typescript
-import { configure, onLink, getInitialLink, claimDeferredIfAvailable, track } from '@li-nk.me/react-native-sdk';
-
-// ... inside your component
-useEffect(() => {
-  configure({
-    appId: 'your-app-id',
-    appKey: 'your-app-key',
-    // ... other options
-  }).then(() => {
-    // 1. Listen for deep links (foreground)
-    onLink((payload) => handlePayload(payload));
-
-    // 2. Check for initial link (cold start)
-    getInitialLink().then((payload) => {
-      if (payload) handlePayload(payload);
-      else {
-        // 3. Check for deferred link (first install)
-        claimDeferredIfAvailable().then((payload) => {
-          if (payload) handlePayload(payload);
-        });
-      }
-    });
-
-    // 4. Track open
-    track('open');
-  });
-}, []);
+await configure({
+  appId: 'your_app_id',
+  appKey: 'your_app_key',
+});
 ```
 
-## UTM & Analytics
-
-LinkMe automatically normalizes UTM parameters from deep links and deferred links. You can map these to your analytics provider (e.g., Firebase):
-
-```typescript
-function handlePayload(payload: LinkMePayload) {
-  if (payload.utm) {
-    // Example: Map to Firebase Analytics
-    // analytics().logEvent('campaign_details', {
-    //   source: payload.utm.source,
-    //   medium: payload.utm.medium,
-    //   campaign: payload.utm.campaign,
-    //   term: payload.utm.term,
-    //   content: payload.utm.content,
-    // });
-  }
-}
-```
+For full documentation, guides, and API reference, please visit our [Help Center](https://li-nk.me/docs/help).
 
-The SDK uses React Native's built-in `Linking` API and requires an Expo config plugin for deep link configuration.
+## License
 
-License: MIT
+Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@li-nk.me/react-native-sdk",
-    "version": "0.1.1",
+    "version": "0.2.0",
     "description": "Pure TypeScript React Native SDK for LinkMe deep and deferred links.",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -24,6 +24,10 @@
         "sdk"
     ],
     "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/r-dev-limited/li-nk.me-react-native-sdk"
+    },
     "peerDependencies": {
         "react": ">=18",
         "react-native": ">=0.72.0",