Skip to content

Commit

Permalink
Brand new lovely GA docs from @Joe-Palmer
Browse files Browse the repository at this point in the history
  • Loading branch information
willmorgan committed Apr 15, 2020
1 parent c728c05 commit e1dde6f
Show file tree
Hide file tree
Showing 2 changed files with 398 additions and 979 deletions.
38 changes: 34 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,42 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Known issues
## 15.04.2020 2.0.0

We are working to deliver durable fixes for this non-exhaustive list of known issues:
## Added

- Face detector changed to Blazeface
- Standalone support checker component
- Assets have been moved to cdn.iproov.app for better load speed

- Occasionally flashing may crash if started quickly. This appears to affect all devices.
- The scan display in some devices may appear warped or squashed.
## Fixed

- Timing regularity restored
- We now wait for WASM modules to fully load before interacting with them (stops crashing)
- SVG repositioning has been tweaked to remove jank
- Video feeds that change resolution, particularly on iMacs, no longer cause face alignment issues
- Bundle size has been reduced as part of an ongoing initiative to reduce page load weight
- King Kong has been tamed 🍌

## Changed

- `@iproov/html5` is now the iProov Web SDK, and so has been renamed to `@iproov/web`
- Class names are now used to identify language text elements rather than blanket tags
- The rotate animation has been switched from lottie to gif (saves bundle size)
- Support is now checked by the support checker component rather than a whitelist of browsers and devices
- Alignment feedback frequency has been tweaked to work better with a new face detector in a future release
- Face detection lifecycle has been tidied to facilitate a new face detector in a future release
- PicoJS's face detector memory allocation and maxFaces have been reduced for performance on lower end/swapping devices
- Various telemetry improvements around face detection: accuracy, reduction in performance cost, etc

## Removed

- Option `screen_brightness` removed; due to lossless encoding and improved adaptive screen brightness, it is no longer needed. Removing it saves around 300kB from the bundle.

## Deprecated

- The screen_brightness animations and usage in older clients have been deprecated and will be removed in a later release.
- Loading assets from the iproov.app domain have been deprecated in favour of using the CDN.

## 14.04.2020 2.0.0-beta-5.6

Expand Down
Loading

0 comments on commit e1dde6f

Please sign in to comment.