Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
40 changes: 7 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@ The following table is a list of supported browsers based on the above requireme

| Browser Name | Version |
| :----------: | :--------------: |
| Chrome | v78+<sup>1</sup> |
| Firefox | v68+<sup>1</sup> |
| Edge | v79+ |
| Safari | v14.5+ |

<sup>1</sup> Devices running iOS need to be on iOS 14.5+ for camera video streaming to work in Chrome, Firefox or other apps using webviews.
| Chrome | v88+ |
| Firefox | v89+ |
| Edge | v88+ |
| Safari | v15+ |

Apart from the browsers, the operating systems may impose some limitations of their own that could restrict the use of the SDK.

Expand Down Expand Up @@ -78,36 +76,17 @@ If you need a web server for standalone or scenario samples (for example, to ser

The repository includes two main sample directories:

- **`frameworks/`** - Framework-specific examples demonstrating how to integrate Dynamsoft Barcode Reader into common web and hybrid frameworks. Each framework folder contains one or more runnable sub-examples (such as `scan-using-foundational-api` and/or `scan-using-rtu-api`) showing practical integration patterns.
- **`frameworks/`** - Framework-specific examples demonstrating how to integrate Dynamsoft Barcode Reader into common web and hybrid frameworks.

- **`scenarios/`** - Focused scenario samples that show common real-world uses of Dynamsoft Barcode Reader.

---

## Choosing an API

The SDK provides two approaches for integrating barcode scanning capabilities:

### Ready-To-Use (RTU) API — BarcodeScanner

The RTU API offers the quickest path to a working barcode scanner (**Recommended for most users**):

- **One-line integration** – Launch a full scanner with a single API call
- **Built-in UI** – Pre-designed viewfinder and scan region highlighting
- **Simple configuration** – Customize behavior through intuitive config objects

### Foundational APIs

If you are looking for a fully customizable barcode decoding library with complete control over the scanning process and UI, you are welcome to use the Foundational APIs.

---

## Documentation

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/docs/web/programming/javascript/?ver=11.2.4000&utm_source=sampleReadme).
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/docs/web/programming/javascript/?ver=11.4.2000&utm_source=sampleReadme).

- [Barcode Scanner API Docs](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/barcode-scanner.html?utm_source=sampleReadme)
- [Foundational API Docs](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/index.html?utm_source=sampleReadme)
- [API Docs](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/index.html?utm_source=sampleReadme)

---

Expand All @@ -125,11 +104,6 @@ If you have any questions, feel free to [contact Dynamsoft support](https://www.
- [scan-a-single-barcode.html](./scan-a-single-barcode.html) — Demonstrates single-barcode scanning: stops and returns as soon as the first barcode is detected.
- [read-an-image.html](./read-an-image.html) — Demonstrates how to decode and read barcodes from uploaded image files.

### Hello-world

- [hello-world.html](./hello-world.html) — The simplest example to get started with single barcode scanning.
- [read-an-image.html](./read-an-image.html) — Demonstrates how to decode and read barcodes from uploaded image files.

### Frameworks

- [angular/](./frameworks/angular/) — Angular examples.
Expand Down
4 changes: 2 additions & 2 deletions frameworks/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Frameworks samples

This directory contains framework-specific examples demonstrating how to integrate the Dynamsoft Barcode Reader (JavaScript edition) into common web and hybrid frameworks. Each framework folder contains one or more runnable sub-examples (for example, scan-using-foundational-api and/or scan-using-rtu-api) showing practical integration patterns.
This directory contains framework-specific examples demonstrating how to integrate the Dynamsoft Barcode Reader (JavaScript edition) into common web and hybrid frameworks.

## Sample list

Expand All @@ -23,7 +23,7 @@ This directory contains framework-specific examples demonstrating how to integra

1. Browse into a framework subfolder and choose a subexample, e.g.:
```cmd
cd react/scan-using-rtu-api
cd react
```
1. Follow the subexample README for exact steps. Typical commands:
```cmd
Expand Down
Loading
Loading