Skip to content

Commit 1baa2b8

Browse files
authored
Merge pull request #53 from Keillion/master
update README.md
2 parents 0c12af9 + f842498 commit 1baa2b8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+367
-63
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,6 @@ __pycache__
5959
!/README.md
6060
!/package.json
6161
!/LICENSE
62+
63+
64+

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Dynamsoft.BarcodeReader.productKeys = 'PRODUCT-KEYS';
6767
- [Read a specific area/region](#read-a-specific-arearegion)
6868
- [Self-hosted Deployment](#self-hosted-deployment)
6969
- [Changelog](#changelog)
70+
- [How to Upgrade](#how-to-upgrade)
7071
- [API Documentation](#api-documentation)
7172
- [License Activation](#license-activation)
7273
- [License Agreement](#license-agreement)
@@ -92,6 +93,16 @@ Dynamsoft.BarcodeReader.productKeys = 'PRODUCT-KEYS';
9293

9394
* Browser Compatibility:
9495

96+
* Unlike normal server-based applications, this library requires some advanced features which fortunately are supported by all mainstream modern browsers. These advanced features are listed below:
97+
* [MediaDevices/getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)
98+
* Required only for in-browser video streaming. If a browser doesn't have this API the [Single Frame Mode](https://www.dynamsoft.com/help/Barcode-Reader-wasm/classes/barcodescanner.html#singleframemode) is used automatically. If the API exists but doesn't work correctly, [Single Frame Mode](https://www.dynamsoft.com/help/Barcode-Reader-wasm/classes/barcodescanner.html#singleframemode) can be used as an alternative.
99+
* [WebAssembly](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/WebAssembly), [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob), [URL/createObjectURL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL), [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
100+
* These four features are required for the library to work.
101+
102+
* Combining the requirements above results in the following table of supported browsers.
103+
104+
> **NOTE**: Apart from the browsers, the operating systems running on the target devices may also impose some limitations of their own that could restrict the use of the library. Therefore, the following table serves as a rough estimation instead of an accurate guideline. Browser compatibility ultimately depends on whether the browser on that particular operating system supports the features listed above.
105+
95106
| Browser Name | Version |
96107
|:-:|:-:|
97108
| Chrome | v57+ (v59+ on Android/iOS<sup>1</sup>) |
@@ -105,6 +116,8 @@ Dynamsoft.BarcodeReader.productKeys = 'PRODUCT-KEYS';
105116

106117
<sup>3</sup> Safari 11.2.2 ~ 11.2.6 are not supported.
107118

119+
>
120+
108121
* Compact and Full Editions
109122

110123
As more and more features are being added to the library, the supporting `wasm` file is getting bigger and bigger. For flexibility, we provide two editions. The compact edition has less features but downloads and compiles faster, on the other hand, the full edition has all features built-in.
@@ -114,7 +127,9 @@ Dynamsoft.BarcodeReader.productKeys = 'PRODUCT-KEYS';
114127
| `wasm` size<sup>1</sup>\(gzip\) | 810KB | 1.1 MB |
115128
| 1D | &radic; | &radic; |
116129
| QR | &radic; | &radic; |
130+
| Mirco QR | **X** | &radic; |
117131
| PDF417 | &radic; | &radic; |
132+
| Mirco PDF417 | **X** | &radic; |
118133
| DataMatrix | &radic; | &radic; |
119134
| Aztec | **X** | &radic; |
120135
| MaxiCode | **X** | &radic; |
@@ -612,6 +627,24 @@ Dynamsoft.BarcodeReader.engineResourcePath = "url/to/the/dir/";
612627

613628
https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx#javascript
614629

630+
## How to Upgrade
631+
632+
#### From version `7.2.2-v2` to `7.3.0-v0`
633+
634+
* If you are using a CDN, just make sure to change the version number in the URL like this
635+
636+
```javascript
637+
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@7.3.0-v0/dist/dbr.js" data-productKeys="PRODUCT-KEYS"></script>
638+
```
639+
640+
* If you have deployed the library files on your own server, you'll need to replace the old files with the ones from the new version. Download the latest version [here](https://www.dynamsoft.com/Downloads/Dynamic-Barcode-Reader-Download.aspx).
641+
642+
#### From versions prior to`7.2.2-v2` to `7.3.0-v0`
643+
644+
Dynamsoft made quite some changes in the version `7.2.2-v2`, therefore it may take a bit more effort to upgrade the library from an older version to the version `7.2.2-v2` or a later version including the latest `7.3.0-v0` (as of January, 2020). Apart from changing the code to include the correct version of the library, you'll also need to make changes to your code related to the APIs of the library. Check out [this post](https://blog.dynamsoft.com/insights/dynamsoft-barcode-reader-sdk-for-javascript-upgrade-from-v7-1-3-to-v7-2-2/) for more information. If you need more help with the upgrade, please feel free to contact [Dynamsoft Support](#contact-us).
645+
646+
647+
615648
## API Documentation
616649

617650
<!--for github: link need use online-->
Lines changed: 12 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/dbr.browser.mjs

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)