From f4144ff84e7a1a8028080b3e304ace3001844142 Mon Sep 17 00:00:00 2001 From: "izaaz.yunus" Date: Wed, 30 Oct 2024 12:11:36 -0700 Subject: [PATCH] chore: adding readme --- .../README.md | 51 +++++++++++++++---- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/packages/plugin-session-replay-react-native/README.md b/packages/plugin-session-replay-react-native/README.md index 089f2e112..10057d79f 100644 --- a/packages/plugin-session-replay-react-native/README.md +++ b/packages/plugin-session-replay-react-native/README.md @@ -9,25 +9,58 @@ npm install @amplitude/plugin-session-replay-react-native ``` ## Usage - +Add the session replay plugin to your Amplitude instance as follows ```js -import { multiply } from '@amplitude/plugin-session-replay-react-native'; +import { SessionReplayPlugin } from '@amplitude/plugin-session-replay-react-native'; // ... -const result = await multiply(3, 7); +await init('YOUR_API_KEY').promise; +await add(new SessionReplayPlugin()).promise; + ``` +## Masking views +To maks certain views, add the `AmpMaskView` tag with the mask property `amp-mask` around the section to be masked -## Contributing +```js +import { AmpMaskView } from '@amplitude/plugin-session-replay-react-native'; -See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. +// ... -## License + + + {title} + + +``` -MIT +## Unmasking views +To unmask views, add the `AmpMaskView` tag with the mask property `amp-unmask` around the section to be unmasked ---- +```js +import { AmpMaskView } from '@amplitude/plugin-session-replay-react-native'; + +// ... -Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob) + + + {title} + + +```