Skip to content

Commit c28f73f

Browse files
Merge pull request #370 from dynamsoft-docs/Tom-Dynamsoft-patch-6
Simplified the part on referencing the library
2 parents 714f996 + eecc938 commit c28f73f

File tree

1 file changed

+8
-17
lines changed
  • programming/javascript/user-guide

1 file changed

+8
-17
lines changed

programming/javascript/user-guide/index.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ In this guide, you will learn step by step on how to integrate the DBR-JS SDK in
3838
- [Building your own page](#building-your-own-page)
3939
- [Include the SDK](#include-the-sdk)
4040
- [Use a public CDN](#use-a-public-cdn)
41+
- [Use NPM](#use-npm)
4142
- [Host the SDK yourself (optional)](#host-the-sdk-yourself-optional)
4243
- [Prepare the SDK](#prepare-the-sdk)
4344
- [Specify the license](#specify-the-license)
@@ -215,26 +216,14 @@ If the test doesn't go as expected, you can [contact us](https://www.dynamsoft.c
215216
216217
To utilize the SDK, the initial step involves including the corresponding resource files:
217218
218-
* `core.js` encompasses common classes, interfaces, and enumerations that are shared across all Dynamsoft SDKs.
219+
* `core.js` encompasses common classes, interfaces, and enumerations shared across all Dynamsoft SDKs.
219220
* `license.js` introduces the `LicenseManager` class, which manages the licensing for all Dynamsoft SDKs.
220-
* `utility.js` encompasses auxiliary classes that are shared among all Dynamsoft SDKs.
221-
* `dbr.js` defines interfaces and enumerations specifically tailored to the barcode reader module.
221+
* `utility.js` encompasses auxiliary classes shared among all Dynamsoft SDKs.
222+
* `dbr.js` defines interfaces and enumerations tailored to the barcode reader module.
222223
* `cvr.js` introduces the `CaptureVisionRouter` class, which governs the entire image processing workflow.
223224
* `dce.js` comprises classes that offer camera support and basic user interface functionalities.
224225
225-
For simplification, starting from version 10.0.21, we introduced `dbr.bundle.js`. Including this file is equivalent to incorporating all six packages.
226-
227-
* [email protected]/dist/core.js
228-
* [email protected]/dist/license.js
229-
* [email protected]/dist/utility.js
230-
* [email protected]/dist/dbr.js
231-
* [email protected]/dist/cvr.js
232-
* [email protected]/dist/dce.js
233-
234-
Equivalent to
235-
* [email protected]/dist/dbr.bundle.js
236-
237-
In the following chapters, we will use `dbr.bundle.js`.
226+
To simplify things, starting from version 10.0.21, we introduced `dbr.bundle.js`, which combines all six of the above files. In the following chapters, we will use `dbr.bundle.js`.
238227
239228
#### Use a public CDN
240229
@@ -260,6 +249,8 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
260249
261250
However, please **DO NOT** use `download2.dynamsoft.com` resources in a production application as they are for temporary testing purposes only. Instead, you can try hosting the SDK yourself.
262251
252+
#### Use NPM
253+
263254
- In frameworks like React and Vue, you may want to add the package as a dependency.
264255
265256
```sh
@@ -268,7 +259,7 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
268259
yarn add [email protected] -E
269260
```
270261
271-
In frameworks you need to [specify the engineResourcePaths](#specify-the-location-of-the-engine-files-optional).
262+
NOTE that in frameworks, you need to [specify the engineResourcePaths](#specify-the-location-of-the-engine-files-optional).
272263
273264
#### Host the SDK yourself (optional)
274265

0 commit comments

Comments
 (0)