Skip to content

Commit d65bb8d

Browse files
authored
Update README.md
added common links & resources
1 parent 2577a17 commit d65bb8d

File tree

1 file changed

+37
-29
lines changed

1 file changed

+37
-29
lines changed

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,61 @@
11
# Dynamsoft Barcode Reader samples for the web
22

3-
This repository contains multiple samples that demonstrates how to use the [Dynamsoft Barcode Reader JavaScript Edition](https://www.dynamsoft.com/barcode-reader/sdk-javascript/).
3+
This repository contains multiple samples that demonstrates how to use the [Dynamsoft Barcode Reader JavaScript Edition](https://www.dynamsoft.com/barcode-reader/sdk-javascript/) for creating web-based barcode scanning applications.
44

5-
## Hello World
5+
## Request a trial license
6+
7+
A default license is included which allows you to test the sample apps for up to 24 hours. You can [request a trial license](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&package=js) via Dynamsoft customer portal to evaluate further.
8+
9+
## Documentation
10+
11+
For the developer guide and full API reference of Dynamsoft Barcode Reader JavaScript library, please check out the [documentation](https://www.dynamsoft.com/barcode-reader/programming/javascript/?ver=latest).
12+
13+
## Support
14+
15+
If you have any questions, feel free to [contact Dynamsoft support](https://www.dynamsoft.com/company/contact).
16+
17+
## Sample list
18+
19+
### Hello World
620

721
Get the basic features of the library working with plain/native JavaScript or within a framework like [Angular](https://angular.io/), [React](https://reactjs.org/) or [Vue](https://vuejs.org/), etc.
822

9-
* **Hello World**: Minimum necessary JavaScript code to get the BarcodeScanner (video) up and running.
10-
* **Read an Existing Image**: Decode barcodes using images that are stored locally, whether on mobile or desktop.
11-
* **Hello World in Angular**: Decode video stream in an Angular Application from a USB-connected or built-in camera (mobile or desktop).
12-
* **Hello World in React**: Decode video stream in a React Application from a USB-connected or built-in camera (mobile or desktop).
13-
* **Hello World in Vue 2**: Decode video stream in a Vue 2 Application from a USB-connected or built-in camera (mobile or desktop).
14-
* **Hello World in Vue 3**: Decode video stream in a Vue 3 Application from a USB-connected or built-in camera (mobile or desktop).
15-
* **Hello World in Next.js**: Decode video stream in a Next.js Application from a USB-connected or built-in camera (mobile or desktop).
16-
* **Hello World in Nuxt**: Decode video stream in a Nuxt Application from a USB-connected or built-in camera (mobile or desktop).
17-
* **Hello World in Electron**: Decode video stream in a Electron Application from a USB-connected or built-in camera (desktop only).
18-
* **Hello World in PWA**: Decode video stream in a PWA Application from a USB-connected or built-in camera (mobile or desktop).
19-
* **Hello World with RequireJS**: Decode video stream in a simple Application using RequireJS from a USB-connected or built-in camera (mobile or desktop).
20-
* **Hello World with ES6**: Decode video stream in a simple Application using ES6 from a USB-connected or built-in camera (mobile or desktop).
21-
22-
## Customize Camera UI
23+
* **Hello World**: Scan barcodes from video stream with minimum code in JavaScript.
24+
* **Read an Existing Image**: Decode barcodes from existing images that are stored locally, whether on mobile or desktop.
25+
* **Hello World in Angular**: Decode video stream in an Angular application from a USB-connected or built-in camera (mobile or desktop).
26+
* **Hello World in React**: Decode video stream in a React application from a USB-connected or built-in camera (mobile or desktop).
27+
* **Hello World in Vue 2**: Decode video stream in a Vue 2 application from a USB-connected or built-in camera (mobile or desktop).
28+
* **Hello World in Vue 3**: Decode video stream in a Vue 3 application from a USB-connected or built-in camera (mobile or desktop).
29+
* **Hello World in Next.js**: Decode video stream in a Next.js application from a USB-connected or built-in camera (mobile or desktop).
30+
* **Hello World in Nuxt**: Decode video stream in a Nuxt application from a USB-connected or built-in camera (mobile or desktop).
31+
* **Hello World in Electron**: Decode video stream in a Electron application from a USB-connected or built-in camera (desktop only).
32+
* **Hello World in PWA**: Decode video stream in a PWA application from a USB-connected or built-in camera (mobile or desktop).
33+
* **Hello World with RequireJS**: Decode video stream in an application using RequireJS from a USB-connected or built-in camera (mobile or desktop).
34+
* **Hello World with ES6**: Decode video stream in an application using ES6 from a USB-connected or built-in camera (mobile or desktop).
35+
36+
### Customize Camera UI
2337

2438
* **Use the Default Camera UI**: Show the default camera UI to decode video stream from a USB-connected or built-in camera (mobile or desktop).
2539
* **Hide Display Controls**: Hide built-in UI elements (camera selection, resolution selection, etc.) and show only the video stream.
2640
* **Set up External Controls**: Use custom controllers to manipulate the Camera UI.
2741
* **Changing Size of Video Viewer**: Enlarge the video stream temporarily to read a barcode.
2842
* **Customize the Camera UI**: Show the custom camera UI to decode video stream from a USB-connected or built-in camera (mobile or desktop).
2943

30-
## Parameter Settings
44+
### Parameter Settings
3145

32-
How to configure different settings of the library.
46+
How to configure different settings of the barcode scanning library.
3347

3448
* **Formats and Count**: Set the barcode formats and control the number of barcodes to read per image/frame.
3549
* **Localization and Binarization**: Set how localization and binarization are done during barcode decoding.
36-
* **Blurry or Small codes**: Set DeblurModes and ScaleUpModes for decoding blurry or small barcodes.
37-
* **Deformed or Incomplete codes**: Set DeformationResistingModes or BarcodeComplementModes for decoding deformed or incomplete barcodes.
38-
* **Define or Detect the Region**: Set the region of interest manually or regionPredetectionModes to speed up the reading process.
39-
40-
## Use Case
50+
* **Blurry or Small codes**: Set `DeblurModes` and `ScaleUpModes` for decoding blurry or small barcodes.
51+
* **Deformed or Incomplete codes**: Set `DeformationResistingModes` or `BarcodeComplementModes` for decoding deformed or incomplete barcodes.
52+
* **Define or Detect the Region**: Set the region of interest manually or `regionPredetectionModes` to speed up the barcode reading process.
4153

42-
Use cases of the library.
54+
### Use Case
4355

4456
* **Read Video and Fill a Form**: Read barcodes to fill a form.
4557
* **Read a Driver's License**: Read the PDF417 barcode on a driver's license (AAMVA compliant) and parse it.
4658

47-
## Others
59+
### Others
4860

4961
* **Debug**: Collect the actual image frames for debugging purposes.
50-
51-
## Support
52-
53-
If you have any questions, feel free to contact Dynamsoft support via [email](mailto:support@dynamsoft.com) or [live chat](https://www.dynamsoft.com/barcode-reader/overview/) via the "Let's Chat" button.

0 commit comments

Comments
 (0)