initial commit

alfred-web-session-recorder/README.md

@@ -0,0 +1,45 @@
+<h1 align="center">Welcome to alfred-session-recorder 👋</h1>
+
+
+> A package that records web sessions, events, and user agents and sends the serialized encrypted data to a specified URL.
+
+
+## 🚀 Usage
+
+Make sure you have node version > 16
+
+Add tokens in .npmrc
+
+```sh
+//https://nexus.cmd.navi-tech.in/repository/npm-packages/:__authToken=NpmToken.1a3d3462-fb82-364c-bc64-0051e24635b3
+```
+Add alfred-session-recorder
+
+```sh
+yarn add @navi/alfred-session-recorder
+```
+
+Use below code snippet below to start sending recorded data to the backend. 
+
+```sh
+ const recorder = new SnapshotRecorder({
+      apiUrl: 'https://qa-alfred-ingester.np.navi-sa.in', // This will change for prod
+      projectName: 'your-project-id',  // Put Project name
+      deviceId?: 'custom-device-id'
+      clientkey : <CONTACT_ALFRED_TEAM>
+    });
+ const cleanup = recorder.startSnapshotRecording();
+```
+
+```
+ recorder.stopRecording(). // Use it to stop recording make sure to use cleanup accordingly
+```
+
+Note: apiUrl for Prod will be different, please reach out to the team for the prod link
+
+## Watch Your Videos here
+
+```
+https://qa-alfred-ui.np.navi-sa.in/
+```
+---