-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from BlinkID/jenkins/stable-build
Automatically built release by Jenkins
- Loading branch information
Showing
85 changed files
with
3,656 additions
and
3,027 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,15 +23,15 @@ Check out live examples of BlinkID ImageCapture SDK in action: | |
|
||
1. [BlinkID ImageCapture SDK with built-in UI](https://blinkid.github.io/blinkid-imagecapture-in-browser/ui/examples/javascript/index.html) | ||
* See what the bare UI looks like at [Codepen](https://codepen.io/microblink/pen/ZEOVRVQ) | ||
2. [BlinkID ImageCapture SDK UI - scan both document sides](https://blinkid.github.io/blinkid-imagecapture-in-browser/ui/examples/javascript-combined/index.html) | ||
2. [BlinkID ImageCapture SDK UI - scan both document sides](https://blinkid.github.io/blinkid-imagecapture-in-browser/ui/examples/javascript-multi-side/index.html) | ||
* See example for scanning of both document sides at [Codepen](https://codepen.io/microblink/pen/pobGzEY) | ||
3. [Scan the front side of an identity document with a web camera](https://blinkid.github.io/blinkid-imagecapture-in-browser/examples/blinkid-camera/javascript/index.html) | ||
* See example at [Codepen](https://codepen.io/microblink/pen/XWKoYPK) | ||
4. [Scan the front side of an identity document by uploading its image](https://blinkid.github.io/blinkid-imagecapture-in-browser/examples/blinkid-file/javascript/index.html) | ||
* See example at [Codepen](https://codepen.io/microblink/pen/bGeOKxZ) | ||
5. [Scan both sides of an identity document with a web camera](https://blinkid.github.io/blinkid-imagecapture-in-browser/examples/combined/javascript/index.html) | ||
5. [Scan both sides of an identity document with a web camera](https://blinkid.github.io/blinkid-imagecapture-in-browser/examples/multi-side/javascript/index.html) | ||
* See example at [Codepen](https://codepen.io/microblink/pen/dyXwKgZ) | ||
6. [Scan both sides of an identity document by uploading its image](https://blinkid.github.io/blinkid-imagecapture-in-browser/examples/combined-file/javascript/index.html) | ||
6. [Scan both sides of an identity document by uploading its image](https://blinkid.github.io/blinkid-imagecapture-in-browser/examples/multi-side-file/javascript/index.html) | ||
* See example at [Codepen](https://codepen.io/microblink/pen/yLVXdEp) | ||
|
||
To see the source code of the above examples, check out the [examples directory](examples). If you'd like to run examples of the UI component, either through the browser or locally, see the [ui/examples](ui/examples) directory. | ||
|
@@ -144,20 +144,20 @@ Alternatively, it's possible to use UMD builds which can be loaded from public C | |
|
||
However, **we strongly advise** that you host the JavaScript bundles on your infrastructure since there is no guarantee that the public CDN service has satisfactory uptime and availability throughout the world. | ||
|
||
For example, it's possible to use UMD builds from [the `dist` folder on Unpkg CDN](https://unpkg.com/@microblink/blinkid-imagecapture-in-browser-sdk/dist/). The UMD builds make `BlinkIDImageCaptureSDK` available as a `window.BlinkIDImageCaptureSDK` global variable: | ||
For example, it's possible to use UMD builds from [the `dist` folder on the jsDelivr CDN](https://cdn.jsdelivr.net/npm/@microblink/blinkid-imagecapture-in-browser-sdk/dist/). The UMD builds make `BlinkIDImageCaptureSDK` available as a `window.BlinkIDImageCaptureSDK` global variable: | ||
|
||
```html | ||
<!-- IMPORTANT: change "X.Y.Z" to the version number you wish to use! --> | ||
<script src="https://unpkg.com/@microblink/[email protected]/dist/blinkid-imagecapture-sdk.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/@microblink/[email protected]/dist/blinkid-imagecapture-sdk.min.js"></script> | ||
``` | ||
|
||
Finally, it's possible to use ES builds, which can be downloaded from [the `es` folder on unpkg](https://unpkg.com/@microblink/blinkid-imagecapture-in-browser-sdk/es/). ES modules are used in a similar manner as NPM package: | ||
Finally, it's possible to use ES builds, which can be downloaded from [the `es` folder on jsDelivr](https://cdn.jsdelivr.net/npm/@microblink/blinkid-imagecapture-in-browser-sdk/es/). ES modules are used in a similar manner as NPM package: | ||
|
||
```javascript | ||
import * as BlinkIDImageCaptureSDK from "./es/blinkid-imagecapture-sdk.js"; | ||
``` | ||
|
||
**Important:** Unpkg CDN is used here due to simplicity of usage. It's not intended to be used in production! | ||
**Important:** the jsDelivr CDN is used here due to simplicity of usage. It's not intended to be used in production! | ||
|
||
#### WASM Resources | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,10 +46,10 @@ However, **we strongly advise** that you host the JavaScript bundle on your infr | |
```html | ||
<!-- After successful load, global variable `Client` is available. --> | ||
<!-- IMPORTANT: change "X.Y.Z" to the version number you wish to use! --> | ||
<script src="https://unpkg.com/@microblink/[email protected]/client-library/dist/client-library.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/@microblink/[email protected]/client-library/dist/client-library.min.js"></script> | ||
``` | ||
|
||
*Keep in mind that Unpkg CDN is used for demonstration, it's not intended to be used in production!* | ||
*Keep in mind that the jsDelivr CDN is used for demonstration, it's not intended to be used in production!* | ||
|
||
### <a name="installation-es-module"></a> ES module | ||
|
||
|
@@ -59,10 +59,10 @@ However, **we strongly advise** that you host the JavaScript bundle on your infr | |
|
||
```js | ||
/* IMPORTANT: change "X.Y.Z" to the version number you wish to use! */ | ||
import { Client } from "https://unpkg.com/@microblink/[email protected]/client-library/es/client-library.mjs"; | ||
import { Client } from "https://cdn.jsdelivr.net/npm/@microblink/[email protected]/client-library/es/client-library.mjs"; | ||
``` | ||
|
||
*Keep in mind that Unpkg CDN is used for demonstration, it's not intended to be used in production!* | ||
*Keep in mind that the jsDelivr CDN is used for demonstration, it's not intended to be used in production!* | ||
|
||
## <a name="usage"></a> Usage | ||
|
||
|
@@ -98,7 +98,7 @@ client.getHealthcheck() | |
const image = "..."; // Base64 representation of image | ||
|
||
/* See API documentation for full list of endpoints and body parameters */ | ||
client.recognize( "/v1/recognizers/blinkid", { "imageSource": image } ) | ||
client.recognize( "/v2/recognizers/blinkid-single-side", { "imageSource": image } ) | ||
.then( ( results: ResponseRecognition ) => | ||
{ | ||
const recognitionResults = results.response.data.result; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.