update README

Author: jaredmixpanel

README.md

@@ -1 +1,137 @@
-# mixpanel-ios-session-replay-package
+# Mixpanel iOS Session Replay SDK
+
+**Session Replay for iOS lets you visually replay your user's app interactions, providing powerful qualitative insights to complement your quantitative analytics.**
+
+---
+
+## Overview
+
+Mixpanel Session Replay enables you to quickly understand **why** users behave a certain way in your app, complementing analytics insights on **where** they drop off.
+
+⚠️ **Beta Notice:** This SDK is currently available via invite-only Beta for Mixpanel Enterprise customers. Please thoroughly test before using in production.
+
+---
+
+## Requirements
+
+- Active Mixpanel account (Enterprise)
+- Mixpanel Swift SDK `v4.3.1` or later
+
+---
+
+## Installation
+
+1. **Download** the [MixpanelSessionReplay.xcframework.zip](https://www.notion.so/Mixpanel-iOS-Session-Replay-SDK-Beta-10ae0ba9256280cdb6e0f39d594cb344?pvs=21) and unzip it.
+2. **In Xcode**, add the `.xcframework` to your target's **Frameworks, Libraries, and Embedded Content**. Set Embed to **Embed & Sign**.
+
+---
+
+## Quick Start
+
+### SwiftUI
+
+```swift
+import Mixpanel
+import MixpanelSessionReplay
+
+struct YourApp: App {
+    @Environment(\.scenePhase) private var scenePhase
+
+    var body: some Scene {
+        WindowGroup {
+            ContentView()
+        }
+        .onChange(of: scenePhase) {
+            if scenePhase == .active {
+                let config = MPSessionReplayConfig(wifiOnly: false, recordSessionsPercent: 100.0)
+                MPSessionReplay.initialize(token: Mixpanel.mainInstance().apiToken,
+                                            distinctId: Mixpanel.mainInstance().distinctId,
+                                            config: config)?.startRecording()
+            }
+        }
+    }
+}
+```
+
+### UIKit
+
+```swift
+import UIKit
+import Mixpanel
+import MixpanelSessionReplay
+
+@main
+class AppDelegate: UIResponder, UIApplicationDelegate {
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
+        Mixpanel.initialize(token: "YOUR_MIXPANEL_TOKEN")
+
+        let config = MPSessionReplayConfig(wifiOnly: false, recordSessionsPercent: 100.0)
+        MPSessionReplay.initialize(token: Mixpanel.mainInstance().apiToken,
+                                   distinctId: Mixpanel.mainInstance().distinctId,
+                                   config: config)
+        #if DEBUG
+        MPSessionReplay.getInstance()?.loggingEnabled = true
+        #endif
+
+        return true
+    }
+
+    func applicationDidBecomeActive(_ application: UIApplication) {
+        MPSessionReplay.getInstance()?.startRecording()
+    }
+}
+```
+
+---
+
+## Configuration
+
+Customize your session replay by modifying `MPSessionReplayConfig`:
+
+- `wifiOnly`: Restricts uploads to WiFi connections (default: `true`).
+- `recordSessionsPercent`: Controls session sampling from `0.0` (none) to `100.0` (all).
+- `autoMaskedViews`: Automatically masks sensitive views (`Image`, `Text`, `Web` by default).
+- `autoCapture`: Controls automatic screenshot capture:
+  - `.enabled` (default), `.viewControllerLifecycle`, `.touch`, or `.disabled`.
+
+---
+
+## Manual Screenshot Capture
+
+If auto capture is disabled, trigger screenshots manually:
+
+```swift
+MPSessionReplay.getInstance()?.captureScreenshot()
+```
+
+---
+
+## Privacy & Data Masking
+
+By default, Mixpanel automatically masks sensitive views:
+
+- All text fields (cannot be unmasked)
+- Images, labels, WebViews (can be manually adjusted)
+
+To manually control sensitivity:
+
+```swift
+// SwiftUI
+Image("photo").mpReplaySensitive(true)
+
+// UIKit
+yourUIView.mpReplaySensitive = true
+```
+
+---
+
+## Resources
+
+- [Full Documentation](https://mixpanel.com/docs/session-replay/session-replay-web)
+- [Legal: Beta Terms](https://mixpanel.com/legal/session-replay-beta-service-addendum)
+
+---
+
+## Support
+
+Questions or feedback? Contact your Mixpanel Account Manager.