Skip to content

Commit 5d5e089

Browse files
committed
Align README.html and README.md content
1 parent 7bd6cf4 commit 5d5e089

2 files changed

Lines changed: 26 additions & 13 deletions

File tree

README.html

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,16 @@ <h2>Quick Start</h2>
130130

131131
<h2>System Requirements</h2>
132132

133-
<h3>Secure Context (HTTPS)</h3>
133+
<h3>Secure Context (HTTPS Deployment)</h3>
134134
<p>
135-
Production deployments must use HTTPS. Camera access and Dynamsoft licensing both require a secure context.
135+
When deploying your application/website for production, make sure to serve it via a secure HTTPS connection. This is required for two reasons:
136136
</p>
137+
<ul>
138+
<li>Access to the camera video stream is only granted in a security context. Most browsers impose this restriction.</li>
139+
<li>Dynamsoft License requires a secure context to work.</li>
140+
</ul>
137141
<p class="callout callout-note">
138-
For local development, <code>http://127.0.0.1</code>, <code>http://localhost</code>, and <code>file:///</code> are allowed by most browsers.
142+
Some browsers like Chrome may grant access for <code>http://127.0.0.1</code> and <code>http://localhost</code> or even for pages opened directly from the local disk (<code>file:///...</code>). This can be helpful for temporary development and testing.
139143
</p>
140144

141145
<h3>Browser Compatibility</h3>
@@ -158,18 +162,22 @@ <h2>License</h2>
158162
to view your trial license details. The trial period can be extended to a total of 60 days.
159163
</p>
160164

161-
<h2>Running Samples Locally</h2>
165+
<h2>Running the Samples Locally</h2>
162166
<p>
163-
The standalone samples in <code>basics/</code> and the scenario samples load the SDK from a CDN,
164-
so you can open them directly by double-clicking — no web server required (internet connection needed).
167+
The standalone samples in the <code>basics/</code> folder (<code>hello-world.html</code>, <code>scan-a-single-barcode.html</code>, <code>read-an-image.html</code>) and scenario samples load the SDK from a CDN, so you can open them directly by double-clicking — no web server required (an internet connection is needed).
165168
</p>
166169
<p>
167-
If you need a local web server (e.g., to serve SDK resources from <code>dist/</code>), a quick option using
168-
<a href="https://code.visualstudio.com/">Visual Studio Code</a>:
170+
To browse all available samples, open <a href="./index.html"><code>index.html</code></a> in your browser — it links to every sample in the repository.
171+
</p>
172+
<p>
173+
For framework samples, follow the instructions in each subfolder's README (typically <code>npm install</code> then <code>npm run dev</code>).
174+
</p>
175+
<p>
176+
If you need a web server for standalone or scenario samples (for example, to serve SDK resources from a local <code>dist/</code> folder), here's a quick method using <a href="https://code.visualstudio.com/">Visual Studio Code</a>:
169177
</p>
170178
<ol>
171-
<li>Install the <a href="https://marketplace.visualstudio.com/items?itemName=yandeu.five-server">Five Server</a> extension.</li>
172-
<li>Right-click an HTML file "Open with Five Server" → served at <code>http://127.0.0.1:5500/</code>.</li>
179+
<li>Install the <a href="https://marketplace.visualstudio.com/items?itemName=yandeu.five-server">Five Server</a> extension from the VS Code Marketplace.</li>
180+
<li>Right-click on an HTML file and select "Open with Five Server". This will serve the application at <code>http://127.0.0.1:5500/</code>.</li>
173181
</ol>
174182

175183
<h2>Sample Folders</h2>
@@ -190,6 +198,11 @@ <h2>Support</h2>
190198
Questions? <a href="https://www.dynamsoft.com/company/contact?utm_source=sampleReadme">Contact Dynamsoft support</a>.
191199
</p>
192200

201+
<h2>Official Online Demo</h2>
202+
<p>
203+
<a href="https://demo.dynamsoft.com/barcode-reader-js"><strong>Official Online Demo</strong></a>: Try the Dynamsoft Barcode Reader JavaScript Edition demo (written in Vue) and see how it works in different modes!
204+
</p>
205+
193206
<div class="footer">
194207
<p>&copy; Dynamsoft. All rights reserved. | <a href="https://www.dynamsoft.com/">dynamsoft.com</a></p>
195208
</div>

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,12 @@ If you need a web server for standalone or scenario samples (for example, to ser
7474

7575
## Sample Folders
7676

77-
The repository includes two main sample directories:
78-
79-
- **`frameworks/`** - Framework-specific examples demonstrating how to integrate Dynamsoft Barcode Reader into common web and hybrid frameworks.
77+
- **`basics/`** - Three foundational samples: hello-world, scan-a-single-barcode, and read-an-image.
8078

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

81+
- **`frameworks/`** - Framework-specific examples demonstrating how to integrate Dynamsoft Barcode Reader into common web and hybrid frameworks.
82+
8383
---
8484

8585
## Documentation

0 commit comments

Comments
 (0)