Merge pull request #51 from Keillion/master

doc

Author: Tom-Dynamsoft

README.md

@@ -121,6 +121,7 @@ Dynamsoft.BarcodeReader.productKeys = 'PRODUCT-KEYS';
   | Patch Code | **X** | √ |
   | GS1 Composite Code | **X** | √ |
   | GS1 DataBar | **X** | √ |
+  | Postal Code | **X** | √ |
   | DPM | **X** | √ |
   | getRuntimeSettings | √ | √ |
   | updateRuntimeSettings | √ | √ |
@@ -563,17 +564,19 @@ For commercial usage, we highly recommend self-hosted deployment. The following
 * **Step one**: Place the files
 
 
-Create a directory called `dist` on your server and put the following files in there.
+On your server put the following files in the same directory.
 
 > [Download zip](https://www.dynamsoft.com/Downloads/Dynamic-Barcode-Reader-Download.aspx?edition=js) to get these files.
 
   ```
-  dbr-<version>.js
-  dbr-<version>.worker.js
-  dbr-<version>.wasm.js
-  dbr-<version>.wasm
-  dbr-<version>.full.wasm.js
-  dbr-<version>.full.wasm
+  dbr.js // For <script>
+  dbr.browser.mjs // For <script type="module">
+  dbr.scanner.html // Scanner default UI
+  dbr-<version>.worker.js // A worker thread for decoding
+  dbr-<version>.wasm.js // Compact Editions
+  dbr-<version>.wasm // Compact Editions
+  dbr-<version>.full.wasm.js // Full Editions
+  dbr-<version>.full.wasm // Full Editions
   ```
 
 * **Step two**: Configure the server
@@ -589,7 +592,12 @@ Create a directory called `dist` on your server and put the following files in t
   > * Java&trade; EE web app: [web.xml](https://github.com/dynamsoft-dbr/javascript-barcode/blob/dac614f8033661901d85381dfaff8d612115862a/documents/conf/web.xml)
   > * Node.js: [npm mime](https://github.com/broofa/node-mime)
 
+* **Step three**: Configure the engineResourcePath
 
+The `engineResourcePath` need to be set before `loadWasm`.
+```js
+Dynamsoft.BarcodeReader.engineResourcePath = "url/to/the/dir/";
+```
 
 ## Changelog
 

doc/api reference/index.html

@@ -241,6 +241,11 @@ <h2>Features</h2>
 									<td align="center"><strong>X</strong></td>
 									<td align="center">&radic;</td>
 								</tr>
+								<tr>
+									<td align="center">Postal Code</td>
+									<td align="center"><strong>X</strong></td>
+									<td align="center">&radic;</td>
+								</tr>
 								<tr>
 									<td align="center">DPM</td>
 									<td align="center"><strong>X</strong></td>
@@ -655,16 +660,18 @@ <h2>Self-hosted Deployment</h2>
 				<ul>
 					<li><strong>Step one</strong>: Place the files</li>
 				</ul>
-				<p>Create a directory called <code>dist</code> on your server and put the following files in there.</p>
+				<p>On your server put the following files in the same directory.</p>
 				<blockquote>
 					<p><a href="https://www.dynamsoft.com/Downloads/Dynamic-Barcode-Reader-Download.aspx?edition=js">Download zip</a> to get these files.</p>
 				</blockquote>
-				<pre><code>  dbr-&lt;version&gt;<span class="hljs-selector-class">.js</span>
-  dbr-&lt;version&gt;<span class="hljs-selector-class">.worker</span><span class="hljs-selector-class">.js</span>
-  dbr-&lt;version&gt;<span class="hljs-selector-class">.wasm</span><span class="hljs-selector-class">.js</span>
-  dbr-&lt;version&gt;<span class="hljs-selector-class">.wasm</span>
-  dbr-&lt;version&gt;<span class="hljs-selector-class">.full</span><span class="hljs-selector-class">.wasm</span><span class="hljs-selector-class">.js</span>
-  dbr-&lt;version&gt;<span class="hljs-selector-class">.full</span><span class="hljs-selector-class">.wasm</span></code></pre><ul>
+				<pre><code>  dbr<span class="hljs-selector-class">.js</span> <span class="hljs-comment">// For &lt;script&gt;</span>
+  dbr<span class="hljs-selector-class">.browser</span><span class="hljs-selector-class">.mjs</span> <span class="hljs-comment">// For &lt;script type="module"&gt;</span>
+  dbr<span class="hljs-selector-class">.scanner</span><span class="hljs-selector-class">.html</span> <span class="hljs-comment">// Scanner default UI</span>
+  dbr-&lt;version&gt;<span class="hljs-selector-class">.worker</span><span class="hljs-selector-class">.js</span> <span class="hljs-comment">// A worker thread for decoding</span>
+  dbr-&lt;version&gt;<span class="hljs-selector-class">.wasm</span><span class="hljs-selector-class">.js</span> <span class="hljs-comment">// Compact Editions</span>
+  dbr-&lt;version&gt;<span class="hljs-selector-class">.wasm</span> <span class="hljs-comment">// Compact Editions</span>
+  dbr-&lt;version&gt;<span class="hljs-selector-class">.full</span><span class="hljs-selector-class">.wasm</span><span class="hljs-selector-class">.js</span> <span class="hljs-comment">// Full Editions</span>
+  dbr-&lt;version&gt;<span class="hljs-selector-class">.full</span><span class="hljs-selector-class">.wasm</span> <span class="hljs-comment">// Full Editions</span></code></pre><ul>
 					<li><p><strong>Step two</strong>: Configure the server</p>
 						<p>Make sure that your webserver serves the <code>*.wasm</code> file with <code>Content-Type: application/wasm</code> . Otherwise the browser won&#39;t be able to recognize it.</p>
 						<p>Basically, all you need to do is set the MIME type for <code>.wasm</code>  to <code>application/wasm</code>.</p>
@@ -678,7 +685,11 @@ <h2>Self-hosted Deployment</h2>
 							</ul>
 						</blockquote>
 					</li>
+					<li><p><strong>Step three</strong>: Configure the engineResourcePath</p>
+					</li>
 				</ul>
+				<p>The <code>engineResourcePath</code> need to be set before <code>loadWasm</code>.</p>
+				<pre><code class="language-js">Dynamsoft.BarcodeReader.engineResourcePath = <span class="hljs-string">"url/to/the/dir/"</span>;</code></pre>
 				<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
 					<h2>Changelog</h2>
 				</a>
@@ -726,7 +737,7 @@ <h2>License Agreement</h2>
 				<a href="#contact-us" id="contact-us" style="color: inherit; text-decoration: none;">
 					<h2>Contact Us</h2>
 				</a>
-				<p>If there are any questions, please feel free to contact <a href="mailto:&#x73;&#117;&#112;&#x70;&#111;&#x72;&#116;&#x40;&#x64;&#x79;&#110;&#x61;&#x6d;&#x73;&#111;&#x66;&#x74;&#x2e;&#99;&#x6f;&#x6d;">&#x73;&#117;&#112;&#x70;&#111;&#x72;&#116;&#x40;&#x64;&#x79;&#110;&#x61;&#x6d;&#x73;&#111;&#x66;&#x74;&#x2e;&#99;&#x6f;&#x6d;</a>.</p>
+				<p>If there are any questions, please feel free to contact <a href="mailto:&#x73;&#x75;&#x70;&#x70;&#x6f;&#114;&#116;&#64;&#x64;&#121;&#110;&#97;&#x6d;&#115;&#x6f;&#x66;&#116;&#x2e;&#x63;&#111;&#x6d;">&#x73;&#x75;&#x70;&#x70;&#x6f;&#114;&#116;&#64;&#x64;&#121;&#110;&#97;&#x6d;&#115;&#x6f;&#x66;&#116;&#x2e;&#x63;&#111;&#x6d;</a>.</p>
 			</div>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">