Update readme #13
Update readme #13
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md documentation to provide comprehensive information about the SDK configuration options and exposed methods for the Mixpanel Session Replay React Native turbo module.
- Added detailed installation instructions for both npm and yarn with version-specific installation examples
- Documented all configuration properties with descriptions, default values, and usage guidelines
- Enhanced method documentation with detailed descriptions, parameters, return values, and error handling information
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
README.md
Outdated
| #### `identify(distinctId: string): Promise<void>` | ||
| Update the user identifier for recordings. | ||
| Sets the distinct ID to session replays. You can use this method to update the distinctId post the Session Replay SDK initialisation. | ||
| It is recommanded to call Identify from Mixpanel main SDK first and then calling identify from the Session Replay SDK. This makes sure to properly merge the users. |
There was a problem hiding this comment.
There is a spelling error: 'recommanded' should be 'recommended'.
| It is recommanded to call Identify from Mixpanel main SDK first and then calling identify from the Session Replay SDK. This makes sure to properly merge the users. | |
| It is recommended to call Identify from Mixpanel main SDK first and then calling identify from the Session Replay SDK. This makes sure to properly merge the users. |
Copilot uses AI. Check for mistakes.
README.md
Outdated
| #### 6. enableLogging | ||
| Enables debug-level logging for the SDK. | ||
| - When set to `true`, the SDK will print verbose debug logs to the console to assist with development and troubleshooting. | ||
| These logs may include internal events, configuration status, and lifecycle hooks relevant to session replay.### Methods |
There was a problem hiding this comment.
Missing line break between the sentence and the '### Methods' header. This creates a formatting issue where the header is concatenated with the previous sentence.
| These logs may include internal events, configuration status, and lifecycle hooks relevant to session replay.### Methods | |
| These logs may include internal events, configuration status, and lifecycle hooks relevant to session replay. | |
| ### Methods |
Copilot uses AI. Check for mistakes.
Updated readme to add information about the SDK config and exposed methods