Skip to content

Commit 067cd05

Browse files
Docs: Update README.md - resync with the guide on site
1 parent 987c4d1 commit 067cd05

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
> See it in action with the [Dynamsoft Document Scanner Demo](https://demo.dynamsoft.com/document-scanner/).
66
7-
This guide walks you through building a web application that scans single-page documents using DDS, with pre-defined configurations.
7+
This guide walks you through building a web application that scans single-page documents using **DDS**, with pre-defined configurations.
88

9-
**Table of Contents** Keep the TOC only for README of the GitHub Repo
9+
**Table of Contents**
1010
- [License](#license)
1111
- [Get a Trial License](#get-a-trial-license)
1212
- [Get a Full License](#get-a-full-license)
@@ -39,9 +39,9 @@ To purchase a full license, [contact us](https://www.dynamsoft.com/company/conta
3939

4040
## Quick Start
4141

42-
To use DDS, the first step is to obtain its library files. You can acquire them from one of the following sources:
42+
The first step in using **DDS** is to obtain its library files. You can acquire them from one of the following sources:
4343

44-
1. [**GitHub**](https://github.com/Dynamsoft/document-scanner-javascript) – Contains the source files for the DDS SDK, which can be compiled into library files.
44+
1. [**GitHub**](https://github.com/Dynamsoft/document-scanner-javascript) – Contains the source files for the **DDS** SDK, which can be compiled into library files.
4545
2. [**npm**](https://www.npmjs.com/package/dynamsoft-document-scanner) – Provides precompiled library files via npm for easier installation.
4646
3. [**CDN**](https://cdn.jsdelivr.net/npm/dynamsoft-document-scanner) – Delivers precompiled library files through a CDN for quick and seamless integration.
4747

@@ -52,11 +52,11 @@ You can choose one of the following methods to set up a Hello World page:
5252

5353
### Option 1: Build from Source
5454

55-
This method retrieves all DDS source files from its [GitHub Repository](https://github.com/Dynamsoft/document-scanner-javascript), compiles them into a distributable package, and then runs a *ready-made* Hello World sample page included in the repository.
55+
This method retrieves all **DDS** source files from its [GitHub Repository](https://github.com/Dynamsoft/document-scanner-javascript), compiles them into a distributable package, and then runs a *ready-made* Hello World sample page included in the repository.
5656

5757
Follow these steps:
5858

59-
1. Download DDS from [GitHub](https://github.com/Dynamsoft/document-scanner-javascript) as a compressed folder.
59+
1. Download **DDS** from [GitHub](https://github.com/Dynamsoft/document-scanner-javascript) as a compressed folder.
6060
2. Extract the contents of the archive.
6161
3. Enter the license key you received in [Get a Trial License](#get-a-trial-license) in the Hello World sample.
6262
> In your code editor, open the Hello World sample located at [`/samples/hello-world.html`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/hello-world.html). Search for `"YOUR_LICENSE_KEY_HERE"` and replace it with your actual license key.
@@ -80,7 +80,7 @@ Once the server is running, open the application in a browser using the address
8080

8181
### Option 2: Use Precompiled Script
8282

83-
Since the DDS library files are published on [npm](https://www.npmjs.com/package/dynamsoft-document-scanner), it's easy to reference them from a CDN.
83+
Since the **DDS** library files are published on [npm](https://www.npmjs.com/package/dynamsoft-document-scanner), it's easy to reference them from a CDN.
8484
8585
To use the precompiled script, simply include the following URL in a `<script>` tag:
8686
```html
@@ -233,11 +233,11 @@ if (result?.correctedImageResult) {
233233
234234
## Custom Usage
235235
236-
This section builds on the Hello World sample to demonstrate how to configure DDS, typically by adjusting the `DocumentScannerConfig` object.
236+
This section builds on the Hello World sample to demonstrate how to configure **DDS**, typically by adjusting the `DocumentScannerConfig` object.
237237
238238
### DocumentScannerConfig Overview
239239
240-
`DocumentScannerConfig` is the primary configuration object for customizing DDS. It includes the following properties:
240+
`DocumentScannerConfig` is the primary configuration object for customizing **DDS**. It includes the following properties:
241241
242242
1. `license`: The license key.
243243
2. `container`: The HTML container for the entire workflow. If not specified (like in the Hello World Sample), one is created automatically.
@@ -257,9 +257,9 @@ This section builds on the Hello World sample to demonstrate how to configure DD
257257
4. `onUpload`: Handler called when the user clicks the "Upload" button.
258258
8. `templateFilePath`: Path to a Capture Vision template. Typically not needed as the default template is used.
259259
9. `utilizedTemplateNames`: Template names for detection and correction. Typically not needed as the default template is used.
260-
10. `engineResourcePaths`: Paths to extra resources such as `.wasm` engine files
260+
10. `engineResourcePaths`: Paths to extra resources such as `.wasm` engine files.
261261
262-
We will discuss two main methods of customizing DDS with `DocumentScannerConfig`:
262+
We will discuss two main methods of customizing **DDS** with `DocumentScannerConfig`:
263263
264264
1. **Workflow Customization**: Through container definitions.
265265
2. **View-Based Customization**: Through configuration objects.
@@ -361,15 +361,15 @@ interface DocumentScannerViewConfig {
361361
362362
We previously covered `container` in [Workflow Customization](#workflow-customization), and changing `templateFilePath` is usually not required. Now, let's focus on `cameraEnhancerUIPath`.
363363
364-
> If DDS performance does not meet your needs in your usage scenario, you may require a customized algorithm template for better results. In this case, please contact our experienced [Technical Support Team](https://www.dynamsoft.com/company/contact/) to discuss your requirements. They will help tailor a suitable template for you, which you can then apply by updating `templateFilePath`.
364+
> If **DDS** performance does not meet your needs in your usage scenario, you may require a customized algorithm template for better results. In this case, please contact our experienced [Technical Support Team](https://www.dynamsoft.com/company/contact/) to discuss your requirements. They will help tailor a suitable template for you, which you can then apply by updating `templateFilePath`.
365365
366366
By default, `cameraEnhancerUIPath` points to a file hosted on the jsDelivr CDN:
367367
[https://cdn.jsdelivr.net/npm/[email protected]/dist/document-scanner.ui.html](https://cdn.jsdelivr.net/npm/[email protected]/dist/document-scanner.ui.html).
368368
369369
This file defines the UI for `DocumentScannerView`. However, since files on the CDN **cannot be modified directly**, you need to use a **local version** to customize the UI. `cameraEnhancerUIPath` is used to specify the local version.
370370
371371
##### Steps to Customize the UI for `DocumentScannerView`
372-
1. Follow the instructions in [Build from Source](#option-1-build-from-source) to obtain the source files for DDS.
372+
1. Follow the instructions in [Build from Source](#option-1-build-from-source) to obtain the source files for **DDS**.
373373
2. Edit `/src/document-scanner.ui.html` to apply your customizations.
374374
3. Build the project to generate the updated file in `/dist/document-scanner.ui.html`:
375375
@@ -547,11 +547,13 @@ const documentScanner = new Dynamsoft.DocumentScanner({
547547
548548
### Self-Hosting Resource Files
549549
550-
By default, DDS relies on a CDN for resources such as `.wasm` engine files. If you require a **fully offline setup**, follow these steps:
551-
> These steps are based on [Build from Source](#option-1-build-from-source), meaning that all DDS source files must be available on your local machine.
550+
By default, **DDS** relies on a CDN for resources such as `.wasm` engine files. If you require a **fully offline setup**, follow these steps:
551+
> These steps are based on [Build from Source](#option-1-build-from-source), meaning that all **DDS** source files must be available on your local machine.
552552
553553
#### Update the Engine Resource Paths and the UI Path:
554554
555+
> In this case, we reference local resource files that are copied during the build process. See [Modify the Build Script](#modify-the-build-script) for details. However, you can also reference your own copies, such as files hosted on your own server. If you need assistance, feel free to [contact us](https://www.dynamsoft.com/company/contact/).
556+
555557
```javascript
556558
const documentScanner = new Dynamsoft.DocumentScanner({
557559
license: "YOUR_LICENSE_KEY_HERE",
@@ -617,6 +619,6 @@ Now, all required files will be **served locally** without relying on a CDN.
617619
618620
## Next Step
619621
620-
DDS is a fully functional, ready-to-use document scanning SDK with built-in UI layouts. However, to extend its capabilities for multi-page and multi-document processing, as well as advanced editing features, we developed **Mobile Web Capture (MWC)**.
622+
**DDS** is a fully functional, ready-to-use document scanning SDK with built-in UI layouts. However, to extend its capabilities for multi-page and multi-document processing, as well as advanced editing features, we developed **Mobile Web Capture (MWC)**.
621623
622624
Read on to learn how to use this web-based wrapper SDK in the [MWC Getting Started Guide](https://www.dynamsoft.com/mobile-web-capture/docs/guides/mobile-web-capture.html).

0 commit comments

Comments
 (0)