feat: Add project structure to readme

README.md

@@ -6,9 +6,82 @@
 | ------------  | ------------------------------------------------------------------------------------ |
 | `VIN Scanner` | Scan the VIN code from a barcode or a text line and extract the vehicle information. |
 
-## License
+## Request a Trial License
+
+The key "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" used in this solution (found in the js/init.js file) is a test license valid for 24 hours for any newly authorized browser. If you wish to test the SDK further, you can request a 30-day free trial license through the <a href="https://www.dynamsoft.com/customer/license/trialLicense?product=mrz&utm_source=docs&package=js" target="_blank">Request a Trial License</a> link.
+
+## Project Structure
+
+```text
+Sample Project
+├── assets
+│   ├── ...
+│   ├── ...
+│   └── ...
+├── css
+│   └── index.css
+├── font
+│   ├── ...
+│   ├── ...
+│   └── ...
+├── js
+│   ├── const.js
+│   ├── index.js
+│   ├── init.js
+│   └── util.js
+├── index.html
+└── template.json
+```
+
+ * `/assets` : This directory contains all the static files such as images, icons, etc. that are used in the project.
+ * `/css` : This directory contains the CSS file(s) used for styling the project.
+ * `/font` : This directory contains the font files used in the project.
+ * `/js` : This directory contains all the JavaScript files used in the project.
+   * `const.js` : This file contains definitions of certain constants or variables used across the project.
+   * `index.js`: This is the main JavaScript file where the core logic of the project is implemented.
+   * `init.js` : This file is used for initialization purposes, such as initializing license, load resources, etc.
+   * `util.js` : This file contains utility functions that are used across the project.
+ * `index.html` : This is the main HTML file that represents the homepage of the project.
+ * `template.json` : This file contains predefined templates used in the project.
+ * `minimum-elements.html` : This HTML file includes the sample project with minimal elements and limited CSS, all contained within a single page.
+
+## System Requirements
+
+This project requires the following features to work:
+
+- Secure context (HTTPS deployment)
+
+  When deploying your application / website for production, make sure to serve it via a secure HTTPS connection. This is required for two reasons
+
+  - Access to the camera video stream is only granted in a security context. Most browsers impose this restriction.
+  > Some browsers like Chrome may grant the access for `http://127.0.0.1` and `http://localhost` or even for pages opened directly from the local disk (`file:///...`). This can be helpful for temporary development and test.
+  
+  - Dynamsoft License requires a secure context to work.
+
+- `WebAssembly`, `Blob`, `URL`/`createObjectURL`, `Web Workers`
+
+  The above four features are required for the SDK to work.
+
+- `MediaDevices`/`getUserMedia`
+
+  This API is required for in-browser video streaming.
+
+- `getSettings`
+
+  This API inspects the video input which is a `MediaStreamTrack` object about its constrainable properties.
+
+The following table is a list of supported browsers based on the above requirements:
+
+  | Browser Name |     Version      |
+  | :----------: | :--------------: |
+  |    Chrome    | v78+<sup>1</sup> |
+  |   Firefox    | v63+<sup>1</sup> |
+  |     Edge     |       v79+       |
+  |    Safari    |       v14+       |
+
+  <sup>1</sup> devices running iOS needs to be on iOS 14.3+ for camera video streaming to work in Chrome, Firefox or other Apps using webviews.
 
-You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense/?product=cvs&utm_source=github&package=js) link.
+Apart from the browsers, the operating systems may impose some limitations of their own that could restrict the use of the SDK. Browser compatibility ultimately depends on whether the browser on that particular operating system supports the features listed above.
 
 ## Testing
 

VINScanner/js/init.js

@@ -83,7 +83,7 @@ async function initDCE() {
 let init = (async function initCVR() {
   await initDCE();
   cvRouter = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
-  await cvRouter.initSettings("./VIN_Template.json");
+  await cvRouter.initSettings("./template.json");
   cvRouter.setInput(cameraEnhancer);
 
   /* Filter out unchecked and duplicate results. */

VINScanner/minimum-elements.html

@@ -67,7 +67,7 @@ <h3 id="scan-title"></h3>
 
         cvRouter.setInput(cameraEnhancer);
         // Set parameters to read VIN through DLR, DBR, and DCP
-        await cvRouter.initSettings("./VIN_Template.json");
+        await cvRouter.initSettings("./template.json");
 
         // Filter out unchecked and duplicate results.
         const filter = new Dynamsoft.Utility.MultiFrameResultCrossFilter();