Skip to content

Commit aec536e

Browse files
committed
update READMEs
1 parent 7d9dec0 commit aec536e

File tree

35 files changed

+195
-118
lines changed

35 files changed

+195
-118
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@ If you have any questions, feel free to [contact Dynamsoft support](https://www.
4141

4242
### Frameworks
4343

44-
- [Angular/](./frameworks/angular/)
45-
- [Blazor/](./frameworks/blazor/)
46-
- [Capacitor/](./frameworks/capacitor/)
47-
- [Electron/](./frameworks/electron/)
48-
- [es6/](./frameworks/es6/)
49-
- [Native-ts/](./frameworks/native-ts/)
50-
- [Next/](./frameworks/next/)
51-
- [Nuxt/](./frameworks/nuxt/)
52-
- [PWA/](./frameworks/pwa/)
53-
- [React/](./frameworks/react/)
54-
- [Requirejs/](./frameworks/requirejs/)
55-
- [Svelte/](./frameworks/svelte/)
56-
- [Vue/](./frameworks/vue/)
57-
- [Webview/](./frameworks/webview/)
44+
- [angular/](./frameworks/angular/) — Angular examples.
45+
- [blazor/](./frameworks/blazor/) — Blazor (.NET) examples.
46+
- [capacitor/](./frameworks/capacitor/) — Capacitor mobile hybrid examples.
47+
- [electron/](./frameworks/electron/) — Electron desktop examples.
48+
- [es6/](./frameworks/es6/) — Plain ES6 module examples.
49+
- [native-ts/](./frameworks/native-ts/) — Native TypeScript examples.
50+
- [next/](./frameworks/next/) — Next.js examples.
51+
- [nuxt/](./frameworks/nuxt/) — Nuxt examples.
52+
- [pwa/](./frameworks/pwa/) — Progressive Web App examples.
53+
- [react/](./frameworks/react/) — React examples.
54+
- [requirejs/](./frameworks/requirejs/) — RequireJS (AMD) examples.
55+
- [svelte/](./frameworks/svelte/) — Svelte examples.
56+
- [vue/](./frameworks/vue/) — Vue examples.
57+
- [webview/](./frameworks/webview/) — Native WebView examples for Android/iOS.
5858

5959
### Scenarios
6060

frameworks/angular/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22

33
This directory contains Angular-based examples demonstrating how to use the Dynamsoft Barcode Reader (JavaScript edition) in Angular projects.
44

5-
Included examples
5+
**Included examples**
6+
67
- scan-using-foundational-api/ — Example using the foundational API.
78
- scan-using-rtu-api/ — Example using the RTU API.
89

9-
Quick start
10+
## Quick start
11+
1012
1. Change to a subexample directory, e.g.:
11-
- cd scan-using-foundational-api
13+
14+
```bash
15+
cd scan-using-foundational-api
16+
```
17+
1218
2. Follow the subexample README for exact steps (typically: npm install && npm run start or ng serve).
1319

14-
Notes
20+
## Notes
21+
1522
- Run examples via the framework dev server. Opening files directly may break module loading or camera access.
1623
- See the repository root README.md for general usage and license information.

frameworks/angular/scan-using-foundational-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this guide, we will be using [`dynamsoft-barcode-reader-bundle 11.2.4000`](ht
1212
1313
## Official sample
1414

15-
* <a target = "_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/angular">Hello World in Angular - Source Code</a>
15+
* <a target = "_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/frameworks/angular">Hello World in Angular - Source Code</a>
1616

1717
## Preparation
1818
Make sure you have [node](https://nodejs.org/) and [Angular CLI](https://cli.angular.io/) installed.

frameworks/angular/scan-using-rtu-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Then open your browser at http://localhost:4200 to view the sample app.
2626

2727
## 📌 Customization
2828

29-
Please refer to sample [`scan-multiple-barcodes`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-multiple-barcodes) or check the official [documentation](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner-customization.html).
29+
Please check the official [documentation](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner-customization.html).
3030

3131
## 📄 Support
3232

frameworks/blazor/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22

33
This directory contains Blazor examples demonstrating how to integrate the Dynamsoft Barcode Reader (JavaScript edition) into Blazor apps.
44

5-
Included examples
5+
**Included examples**
6+
67
- scan-using-foundational-api/ — Blazor example with JS interop for video/image decoding.
78
- scan-using-rtu-api/ — RTU API demo for Blazor.
89

9-
Quick start
10+
## Quick start
11+
1012
1. Change to a subexample directory, e.g.:
11-
- cd scan-using-foundational-api
13+
14+
```bash
15+
cd scan-using-foundational-api
16+
```
17+
1218
2. Follow the subexample README for exact steps (may require dotnet/SDK commands or npm for static assets).
1319

14-
Notes
20+
## Notes
21+
1522
- Some examples use JS interop; run the app via dotnet or the provided launch configuration.
1623
- See the repository root README.md for general usage and license information.

frameworks/blazor/scan-using-foundational-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this guide, we will be using [`dynamsoft-barcode-reader-bundle 11.2.4000`](ht
1212
1313
## Official Sample
1414

15-
* <a target = "_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/blazor">Hello World in Blazor - Source Code</a>
15+
* <a target = "_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/frameworks/blazor">Hello World in Blazor - Source Code</a>
1616

1717
## Preparation
1818

frameworks/blazor/scan-using-rtu-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This sample demonstrates how to use the `BarcodeScanner` API from the [Dynamsoft
1010

1111
## 📌 Customization
1212

13-
Please refer to sample [`scan-multiple-barcodes`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-multiple-barcodes) or check the official [documentation](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner-customization.html).
13+
Please refer check the official [documentation](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner-customization.html).
1414

1515
## 📄 Support
1616

frameworks/capacitor/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22

33
This directory contains Capacitor examples showing how to use the Dynamsoft Barcode Reader in hybrid mobile apps (Android / iOS) via Capacitor.
44

5-
Included examples
5+
**Included example**
6+
67
- scan-using-rtu-api/ — Capacitor project illustrating RTU API usage.
78

8-
Quick start
9+
## Quick start
10+
911
1. Change to the example directory, e.g.:
10-
- cd scan-using-rtu-api
12+
13+
```bash
14+
cd scan-using-rtu-api
15+
```
16+
1117
2. Follow the subexample README for platform-specific setup (npm install, capacitor sync, open Android Studio/Xcode).
1218

13-
Notes
19+
## Notes
20+
1421
- Mobile platform setup is required to run native apps. See the subexample README for exact steps.
1522
- See the repository root README.md for general usage and license information.

frameworks/capacitor/scan-using-rtu-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Notice we add camera permission in `AndroidManifest.xml` and `Info.plist`.
3636

3737
## 📌 Customization
3838

39-
Please refer to sample [`scan-multiple-barcodes`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-multiple-barcodes) or check the official [documentation](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner-customization.html).
39+
Please check the official [documentation](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner-customization.html).
4040

4141
## 📄 Support
4242

frameworks/electron/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22

33
This directory contains Electron examples demonstrating desktop apps using the Dynamsoft Barcode Reader (JavaScript edition).
44

5-
Included examples
5+
**Included examples**
6+
67
- scan-using-foundational-api/ — Electron demo using foundational API.
78
- scan-using-rtu-api/ — Electron demo using RTU API.
89

9-
Quick start
10+
## Quick start
11+
1012
1. Change to a subexample directory, e.g.:
11-
- cd scan-using-foundational-api
13+
14+
```bash
15+
cd scan-using-foundational-api
16+
```
17+
1218
2. Follow the subexample README for exact steps (typically: npm install && npm run start or npm run electron).
1319

14-
Notes
20+
## Notes
21+
1522
- Desktop examples may require additional native build steps for packaging. Run via the provided dev command.
1623
- See the repository root README.md for general usage and license information.

0 commit comments

Comments
 (0)