@powercred/liveness-web 0.1.0 → 0.1.1

package/README.md

@@ -51,7 +51,12 @@ the `assets` folder, and load the script build. It defines `window.PowerCredLive
 
 ## Quick start
 
-### 1. Start a check from your backend
+### 1. Create a session on your server
+
+This is the only step on your side that isn't in the browser: one call from your own server to the
+PowerCred API, which returns a session for this check. It stays on your server because it uses
+your API key, which must never be put in a web page. The SDK does everything else: the camera,
+the moves, the recording and the upload.
 
 ```js
 // Your server (Node.js shown; any language works)
@@ -141,7 +146,7 @@ new PowerCredLiveness(options)
 | `flash` | `true` | `false` skips the colour sequence even if the session asks for it |
 | `assetsUrl` | `assets/` next to the SDK | Where the [assets folder](#hosting-the-assets-folder) is served from |
 | `timedWindowSeconds` | `3.5` | Seconds per move when the browser shows timed prompts |
-| `maxLocalRetries` | `2` | How many times the person may restart after a problem the browser catches (wrong way, face lost, too slow). These restarts don't use up attempts. |
+| `maxLocalRetries` | `2` | How many times the person may restart after a problem the browser catches (wrong way, face lost, too slow). These restarts don't use up attempts. Leaving the page mid-check (another tab or app) also restarts the attempt, but never counts towards this limit. |
 | `showResult` | `true` | Show the built-in final screen (passed, failed or error). Set `false` to show your own when `start()` resolves. The prompts, and "Try again" between attempts, still appear. |
 | `strings` | English | Replace any on-screen text. See [Customising](#customising-the-look-and-text). |
 | `theme` | | `{ primaryColor, fontFamily }` |
@@ -213,7 +218,7 @@ check.
 | `{ type: 'recording_started' }` | Recording began |
 | `{ type: 'challenge_started', challenge }` | A move was asked for |
 | `{ type: 'challenge_passed', challenge }` | The browser saw the move |
-| `{ type: 'attempt_aborted', reason }` | The browser stopped the attempt: `wrong_direction`, `face_lost`, `multiple_faces`, `too_slow` or `challenge_timeout:<move>`. The person is offered a restart. |
+| `{ type: 'attempt_aborted', reason }` | The browser stopped the attempt: `wrong_direction`, `face_lost`, `multiple_faces`, `too_slow`, `challenge_timeout:<move>`, or `interrupted` (the person switched to another tab or app mid-check). Nothing is uploaded, and the person is offered a restart. |
 | `{ type: 'flash_started' }`, `{ type: 'flash_ended' }` | The colour sequence |
 | `{ type: 'uploading', bytes }` | The recording is being sent |
 | `{ type: 'server_result', result }` | PowerCred's verdict for an attempt |