x3d-tidy 2.0.26 → 2.0.28

package/README.md

@@ -12,6 +12,19 @@ You can run *x3d-tidy* without installing it using **npx**:
 
 **npx x3d-tidy** \[options\] -i input-file -o output-file [-i input-file -o output-file ...]
 
+## Overview
+
+*x3d-tidy* is a command-line tool designed for processing X3D (Extensible 3D) files. It provides both conversion and data mining capabilities to enhance and streamline working with X3D content.
+
+* Run *x3d-tidy* with `npx x3d-tidy ...` directly from npm without installing it.
+* Format Conversion: Transforms X3D files between different encodings, such as XML, Classic VRML, and JSON.
+* Syntax Cleanup: Ensures well-formed and standardized X3D output by fixing structural inconsistencies and formatting issues.
+* Data Extraction: Mines relevant data from X3D scenes, allowing analysis and reuse of geometries, metadata, and structure.
+* Validation & Optimization: Helps identify errors, redundant elements, and inefficiencies in X3D models.
+* Command-line Usability: Easily integrates into automation workflows and scripts for batch processing.
+
+This tool is particularly useful for developers, 3D artists, and researchers working with X3D-based applications, ensuring clean, efficient, and interoperable files.
+
 ## Options
 
 **x3d-tidy** interprets the following options when it is invoked:
@@ -26,7 +39,7 @@ Set output file(s). To output it to stdout use only the extension, e.g. ".x3dv".
 
 ### -s *[**TIDY**, COMPACT, SMALL, CLEAN]*
 
-Set output style, default is "TIDY". "TIDY" results in a good readable file, but with larger size, whereas "CLEAN" result in the smallest size possible. The other values are somewhere in between.
+Set output style, default is "TIDY". "TIDY" results in a good readable file, but with larger size, whereas "CLEAN" result in the smallest size possible by removing all redundant whitespaces. The other values are somewhere in between.
 
 ### -d *integer*
 
@@ -83,10 +96,9 @@ Convert an XML encoded file to a VRML encoded file.
 $ npx x3d-tidy -i file.x3d -o file.x3dv
 ```
 
-Convert an XML encoded file to a VRML encoded file and a JSON encoded file.
-
+Convert an XML encoded file to a VRML encoded file and a JSON encoded file with smallest size possible by removing redundant whitespaces.
 ```sh
-$ npx x3d-tidy -i file.x3d -o file.x3dv file.x3dj
+$ npx x3d-tidy -s CLEAN -i file.x3d -o file.x3dv file.x3dj
 ```
 
 ## Online Converter

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "x3d-tidy",
-   "version": "2.0.26",
+   "version": "2.0.28",
    "description": "X3D Converter, Beautifier and Minimizer",
    "main": "src/main.js",
    "bin": {
@@ -53,8 +53,8 @@
       }
    ],
    "dependencies": {
-      "x_ite": "^11.3.2",
-      "x_ite-node": "^1.0.35",
+      "x_ite": "^11.4.1",
+      "x_ite-node": "^1.0.37",
       "x3d-traverse": "^1.0.10",
       "yargs": "^17.7.2"
    },

package/src/main.js

@@ -66,7 +66,7 @@ async function convert ()
    {
       type: "string",
       alias: "s",
-      description: `Set output style, default is "TIDY". "TIDY" results in a good readable file, but with larger size, whereas "CLEAN" result in the smallest size possible. The other values are somewhere in between.`,
+      description: `Set output style, default is "TIDY". "TIDY" results in a good readable file, but with larger size, whereas "CLEAN" result in the smallest size possible by removing all redundant whitespaces. The other values are somewhere in between.`,
       choices: ["TIDY", "COMPACT", "SMALL", "CLEAN"],
       array: true,
       default: ["TIDY"],
@@ -109,8 +109,8 @@ async function convert ()
          "Convert an XML encoded file to a VRML encoded file."
       ],
       [
-         "npx x3d-tidy -i file.x3d -o file.x3dv file.x3dj",
-         "Convert an XML encoded file to a VRML encoded file and a JSON encoded file."
+         "npx x3d-tidy -s CLEAN -i file.x3d -o file.x3dv file.x3dj",
+         "Convert an XML encoded file to a VRML encoded file and a JSON encoded file with smallest size possible by removing redundant whitespaces"
       ],
    ])
    .help ()