Skip to content

Commit d30794a

Browse files
Update README.md
1 parent 07b8a88 commit d30794a

File tree

1 file changed

+12
-30
lines changed

1 file changed

+12
-30
lines changed

README.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88

99
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.
1010

11-
⚠️ **Beta Notice:** This SDK is currently available via invite-only Beta for Mixpanel Enterprise customers. Please thoroughly test before using in production.
12-
1311
---
1412

1513
## Requirements
@@ -32,7 +30,7 @@ Open **podfile** and add Mixpanel Session Replay library to your dependencies:
3230

3331
```
3432
target 'MyApp' do
35-
pod 'MixpanelSessionReplay', :git => 'https://github.com/mixpanel/mixpanel-ios-session-replay-package.git', :tag => 'v0.3.3'
33+
pod 'MixpanelSessionReplay', :git => 'https://github.com/mixpanel/mixpanel-ios-session-replay-package.git', :tag => 'v1.0.0'
3634
end
3735
```
3836

@@ -59,10 +57,8 @@ struct YourApp: App {
5957
}
6058
.onChange(of: scenePhase) {
6159
if scenePhase == .active {
62-
let config = MPSessionReplayConfig(wifiOnly: false, recordSessionsPercent: 100.0)
63-
MPSessionReplay.initialize(token: Mixpanel.mainInstance().apiToken,
64-
distinctId: Mixpanel.mainInstance().distinctId,
65-
config: config)?.startRecording()
60+
let config = MPSessionReplayConfig(wifiOnly: false, enableLogging: true)
61+
MPSessionReplay.initialize(token: Mixpanel.mainInstance().apiToken, distinctId: Mixpanel.mainInstance().distinctId, config: config)
6662
}
6763
}
6864
}
@@ -81,13 +77,8 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
8177
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
8278
Mixpanel.initialize(token: "YOUR_MIXPANEL_TOKEN")
8379

84-
let config = MPSessionReplayConfig(wifiOnly: false, recordSessionsPercent: 100.0)
85-
MPSessionReplay.initialize(token: Mixpanel.mainInstance().apiToken,
86-
distinctId: Mixpanel.mainInstance().distinctId,
87-
config: config)
88-
#if DEBUG
89-
MPSessionReplay.getInstance()?.loggingEnabled = true
90-
#endif
80+
let config = MPSessionReplayConfig(wifiOnly: false, enableLogging: true)
81+
MPSessionReplay.initialize(token: Mixpanel.mainInstance().apiToken, distinctId: Mixpanel.mainInstance().distinctId, config: config)
9182

9283
return true
9384
}
@@ -105,29 +96,20 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
10596
Customize your session replay by modifying `MPSessionReplayConfig`:
10697

10798
- `wifiOnly`: Restricts uploads to WiFi connections (default: `true`).
108-
- `recordSessionsPercent`: Controls session sampling from `0.0` (none) to `100.0` (all).
109-
- `autoMaskedViews`: Automatically masks sensitive views (`Image`, `Text`, `Web` by default).
110-
- `autoCapture`: Controls automatic screenshot capture:
111-
- `.enabled` (default), `.viewControllerLifecycle`, `.touch`, or `.disabled`.
112-
113-
---
114-
115-
## Manual Screenshot Capture
116-
117-
If auto capture is disabled, trigger screenshots manually:
118-
119-
```swift
120-
MPSessionReplay.getInstance()?.captureScreenshot()
121-
```
99+
- `autoMaskedViews`: Automatically masks sensitive views (`.image`, `.text`, `.web`, `.map` by default).
100+
- `autoStartRecording`: Whether or not to automatically start recording upon initialization (default: `true`)
101+
- `autoStartRecordingSessionsPercent`: Controls session sampling from `0.0` (none) to `100.0` (all, default) when `autoStartRecording` is `true` .
102+
- `enableLogging`: Turn on debug logs (default: false)
103+
- `flushInterval`: How frequently to flush replay events (default: 10 seconds)
122104

123105
---
124106

125107
## Privacy & Data Masking
126108

127109
By default, Mixpanel automatically masks sensitive views:
128110

129-
- All text fields (cannot be unmasked)
130-
- Images, labels, WebViews (can be manually adjusted)
111+
- All text field inputs (cannot be unmasked)
112+
- Images, Labels, WebViews, MapViews (can be manually adjusted)
131113

132114
To manually control sensitivity:
133115

0 commit comments

Comments
 (0)