@file-viewer/docx 0.3.22 → 0.3.24

package/README.md

@@ -4,7 +4,7 @@
 
 Pure HTML DOCX renderer for browser-based Word previews. This package preserves the final non-canvas `docx-viewer` line as a stable maintenance track, converting WordprocessingML into HTML while keeping semantic structure, page layout, headers/footers, numbering, fields, tables, images and common DrawingML content as closely as browser layout allows.
 
-This fork includes production hardening for large Word documents: Worker-based parsing, asynchronous rendering yields, Word-saved pagination support, dynamic overflow pagination and layout telemetry.
+This fork includes production hardening for large Word documents: optional Worker parsing with a main-thread fallback, asynchronous rendering yields, Word-saved pagination support, dynamic overflow pagination and layout telemetry.
 
 ## Installation
 
@@ -156,7 +156,7 @@ The production path is intentionally split into stages:
 4. `awaitRenderedLayout` waits for images and fonts, runs dynamic overflow pagination and returns a `LayoutSnapshot`.
 5. `collectLayoutSnapshot` can be used in CI or telemetry to detect overflow pages, unresolved media, page count, aggregate text length, fields and floating objects.
 
-This avoids the former demo-page freeze caused by synchronous ZIP/XML parsing and very large DOM construction on the UI thread.
+Batch rendering and browser yields avoid the former demo-page freeze caused by inserting very large DOM trees in one task. When Worker parsing is enabled, keep `workerFallback: true` unless the target Worker runtime provides every required XML API.
 
 ## Pagination, headers/footers and TOC
 
@@ -201,13 +201,29 @@ It renders `tests/regression/database-design.docx` and asserts that TOC entries
 
 ## Build
 
-This repository includes a lightweight build script that emits CommonJS, ESM and Worker bundles without requiring a full Rollup install in constrained environments:
+This repository includes a lightweight build script that emits synchronized, minified CommonJS, ESM and Worker bundles:
 
 ```bash
 npm run build
 ```
 
-The emitted `.min.*` files are functionally synchronized builds. Use a production minifier if you need compressed bundle size.
+Run the complete build and semantic regression suite with:
+
+```bash
+npm run verify
+```
+
+Browser-focused checks remain available through `npm run e2e`, `npm run e2e:chart` and `npm run e2e:header-guard`.
+
+## Local demo
+
+Serve the repository over HTTP and open the root page:
+
+```bash
+python3 -m http.server 8000
+```
+
+The demo is self-contained for normal DOCX files, includes sample documents, page navigation, light/dark rendering and an options panel. TIFF support is loaded only when a document actually contains TIFF media.
 
 ## Notes on fidelity