@affogatosoftware/recorder 1.0.1 → 1.0.2

package/README.md

@@ -1,13 +1,41 @@
-Usage:
-```
+### Quick Start:
+
+Don't forget to replace 'YOUR_API_TOKEN' with your actual api token.
+
+#### In your js/ts code:
+```aiignore
 import { Recorder } from '@affogatosoftware/recorder';
+...
+const rec = new Recorder(window, 'YOUR_API_TOKEN', { MaskingLevel.InputPasswordOrEmailAndTextArea });
+rec.start();
 ```
 
-or add a script tag:
+#### Put this script tag at the end of the header tag in your index.html:
+```aiignore
+<script type="module">
+  import 'https://unpkg.com/@affogatosoftware/recorder/dist/browser/recorder.es.js';
+  const rec = new Recorder(window, 'YOUR_API_TOKEN', { MaskingLevel.InputPasswordOrEmailAndTextArea });
+  rec.start();
+</script>
+
 ```
+
+#### Or if module scripts don't work for you, do it this way:
+```aiignore
+<script src="https://unpkg.com/@affogatosoftware/recorder/dist/browser/recorder.iife.js"></script>
 <script>
-  const r = new window.Recorder.Recorder(window, 'PUBLIC_TOKEN', { maskingLevel: 'none' });
-  r.start();
+  const rec = new Recorder(window, 'YOUR_API_TOKEN', { MaskingLevel.InputPasswordOrEmailAndTextArea });
+  rec.start();
 </script>
 ```
 
+### Masking Options
+The masking level that gets passed in when the Recorder object is created will dictate what elements will turn their text into an asterisks (*).
+This can be passed in using the MaskingLevel enum (ex. MaskingLevel.InputAndTextArea) or as a string ("InputAndTextArea").
+
+* None: Nothing will get masked. Everything will be recorded and stored. **Make sure you have the user's permission to store potential PII.**
+* All: All text will be masked.
+* InputAndTextArea: All input and text area tags will have their text masked.
+* InputPasswordOrEmailAndTextArea: All input tags of type password and email will have their text masked. All text area tags will ahve their text masked.
+
+If you want a safe default that won't require you to make a cookie banner, choose All. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affogatosoftware/recorder",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
   "author": "Chris Ryan",
   "main": "./dist/index.js",