@attryio/react-native 0.1.6 → 0.1.7

package/README.md

@@ -1,40 +1,144 @@
 # @attryio/react-native
 
-React Native SDK for Attry mobile attribution.
+React Native SDK for [Attry](https://attry.io), a mobile app analytics and attribution platform for campaign analytics, app user analytics, deep links, deferred deep links, and revenue events.
+
+Use this package when your app is built with React Native. It collects install/open/session signals automatically, keeps one stable installation ID, resolves Attry deep links, and lets you send custom product events with structured properties.
+
+## Links
+
+- Website: [attry.io](https://attry.io)
+- Dashboard: [app.attry.io](https://app.attry.io)
+- Event tracking docs: [attry.io/resources/event-tracking](https://attry.io/resources/event-tracking)
+- Standard events: [attry.io/resources/standard-events](https://attry.io/resources/standard-events)
+- Domain setup: [attry.io/resources/domain-setup](https://attry.io/resources/domain-setup)
+
+## Install
+
+```sh
+npm install @attryio/react-native
+```
+
+For iOS, install pods after adding the package:
+
+```sh
+cd ios && pod install
+```
+
+Use the App ID and live SDK key from **Settings -> SDK install** in your Attry dashboard. Each Attry app has one App ID and one live key; you do not need separate keys for iOS and Android.
+
+## Quick start
+
+Create the client once during app startup.
 
 ```ts
 import { createAttryReactNative } from "@attryio/react-native";
 
-const attry = await createAttryReactNative({
+export const attry = await createAttryReactNative({
   appId: "457064853",
   apiKey: "attry_live_..."
 });
+```
+
+The SDK starts with practical defaults:
+
+- Tracks the first SDK install, app opens, session starts/ends, foreground/background changes, and deep link opens.
+- Collects React Native context such as platform, app version, build, OS version, device model, locale, timezone, screen, and available country context.
+- Resolves Android Google Play Install Referrer when the native module is available.
+- Requests Apple AdServices attribution tokens on iOS when the native module is available.
+- Batches events and retries failed requests through the shared Attry SDK engine.
+
+## Track custom events
+
+Use `track` for app-specific actions. Event names should be stable `snake_case`; details belong in `properties`.
+
+```ts
+await attry.track("flashcards_generated", {
+  properties: {
+    deckId: "deck_123",
+    cardCount: 18,
+    source: "lesson"
+  }
+});
+```
 
+Attach a signed-in user ID with `identify`. This is a method, not an event.
+
+```ts
+attry.identify("user_123");
+```
+
+## Purchase intent and revenue
+
+Use `initiatePurchase` when the user starts a checkout, subscription, or paywall purchase flow.
+
+```ts
 await attry.initiatePurchase({
   properties: {
     productId: "pro_monthly",
     placement: "paywall"
   }
 });
+```
+
+Use `purchase` when money was actually captured or a paid conversion happened. `purchase` must include `value` or `amountMinor` plus `currency`.
 
+```ts
 await attry.purchase({
   value: 31.42,
   currency: "USD",
   productId: "pro_monthly",
-  transactionId: "txn_123"
+  transactionId: "txn_123",
+  store: "app_store",
+  properties: {
+    plan: "monthly"
+  }
 });
 ```
 
-The SDK auto-tracks first SDK install, app opens, sessions, foreground/background transitions, deep link opens, Apple AdServices tokens on iOS, and Google Play Install Referrer on Android when the native modules are available.
+Attry stores revenue as stable minor-unit fields, so campaign revenue is not guessed from arbitrary custom properties.
 
 ## Standard events
 
 Attry accepts custom event names, but these standard names are reserved for dashboard reporting:
 
-- Lifecycle: `install`, `open`, `session_started`, `session_ended`, `app_foreground`, `app_background`, `deep_link_opened`
-- Revenue: `purchase`
-- Commerce/content: `initiate_purchase`
+| Event | Sent by | Purpose |
+| --- | --- | --- |
+| `install` | SDK | First SDK install for the current app installation. |
+| `open` | SDK | App opened or became active. |
+| `session_started` | SDK | A new app usage session started. |
+| `session_ended` | SDK | A session ended after backgrounding or timeout. |
+| `app_foreground` | SDK | App returned to the foreground. |
+| `app_background` | SDK | App moved to the background. |
+| `deep_link_opened` | SDK | App opened from a deep link, universal link, or app link. |
+| `initiate_purchase` | App | User started a purchase or subscription flow. |
+| `purchase` | App | Paid conversion or purchase revenue. Requires revenue. |
+
+Everything else can be sent as a custom event with `track("your_event_name", { properties })`.
+
+## Configuration
+
+```ts
+const attry = await createAttryReactNative({
+  appId: "457064853",
+  apiKey: "attry_live_...",
+  autoTrackLifecycleEvents: true,
+  autoTrackDeepLinks: true,
+  autoCollectInstallAttribution: true,
+  sessionTimeoutMs: 30 * 60 * 1000,
+  context: {
+    appName: "Noteasy"
+  }
+});
+```
+
+Useful options:
+
+- `endpoint`: custom Attry API endpoint. Defaults to `https://api.attry.io`.
+- `autoTrackLifecycleEvents`: disable automatic lifecycle events when set to `false`.
+- `autoTrackDeepLinks`: disable automatic deep link tracking when set to `false`.
+- `autoCollectInstallAttribution`: disable Apple AdServices and Play Install Referrer collection when set to `false`.
+- `context`: extra app, device, or release metadata attached to every event.
 
-`identify()` is a convenience method that attaches a known user ID to later events; it is not sent as a standard event. Any other product action can still be sent with `track("your_event_name", { properties })`.
+## Need help?
 
-Purchase events must include `value` or `amountMinor` plus `currency`. Attry stores them as stable minor-unit revenue fields so dashboard revenue is not guessed from arbitrary properties.
+Email [hello@attry.io](mailto:hello@attry.io) or open the [Attry dashboard](https://app.attry.io).

package/dist/index.js

@@ -1,6 +1,6 @@
 import { Attry, ATTRY_EVENTS, MemoryStorage, parseAttryUrl } from "@attryio/sdk-core";
 const SDK_NAME = "attry-react-native";
-const SDK_VERSION = "0.1.6";
+const SDK_VERSION = "0.1.7";
 export { parseAttryUrl };
 export async function createAttryReactNative(config) {
     const rn = await loadReactNative();

package/package.json

@@ -1,9 +1,33 @@
 {
   "name": "@attryio/react-native",
-  "version": "0.1.6",
+  "version": "0.1.7",
+  "description": "React Native SDK for Attry mobile app analytics, attribution, deep links, deferred deep links, and revenue events.",
   "private": false,
   "license": "Apache-2.0",
   "type": "module",
+  "homepage": "https://attry.io",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mozhn/attry.io.git",
+    "directory": "packages/sdk-react-native"
+  },
+  "bugs": {
+    "url": "https://github.com/mozhn/attry.io/issues"
+  },
+  "keywords": [
+    "attry",
+    "react native analytics",
+    "react native attribution",
+    "mobile analytics",
+    "mobile attribution",
+    "deep links",
+    "deferred deep links",
+    "app analytics",
+    "campaign analytics",
+    "revenue analytics",
+    "apple search ads",
+    "install referrer"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -31,7 +55,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@attryio/sdk-core": "0.1.3",
+    "@attryio/sdk-core": "0.1.4",
     "@react-native-async-storage/async-storage": "^2.2.0"
   },
   "peerDependencies": {