Update readme

README.md

@@ -111,6 +111,8 @@ export type ODiffOptions = Partial<{
   antialiasing: boolean;
   /** If `true` reason: "pixel-diff" output will contain the set of line indexes containing different pixels */
   captureDiffLines: boolean;
+  /** If `true` odiff will use less memory but will be slower with larger images */
+  reduceRamUsage: boolean;
   /** An array of regions to ignore in the diff. */
   ignoreRegions: Array<{
     x1: number;

bin/Main.ml

@@ -14,15 +14,15 @@ type 'output diffResult = { exitCode : int; diff : 'output option }
 (* Arguments must remain positional for the cmd parser lib that we use *)
 let main img1Path img2Path diffPath threshold outputDiffMask failOnLayoutChange
     diffColorHex toEmitStdoutParsableString antialiasing ignoreRegions diffLines
-    disableMemoryOptimizations =
+    disableGcOptimizations =
   (*
       We do not need to actually maintain memory size of the allocated RAM by odiff, so we are
       increasing the minor memory size to avoid most of the possible deallocations. For sure it is 
       not possible be sure that it won't be run in OCaml because we allocate the Stack and Queue
 
       By default set the minor heap size to 256mb on 64bit machine
   *)
-  if not disableMemoryOptimizations then
+  if not disableGcOptimizations then
     Gc.set
       {
         (Gc.get ()) with

bin/ODiffBin.ml

@@ -56,7 +56,7 @@ let diffLines =
         "With this flag enabled, output result in case of different images \
          will output lines for all the different pixels"
 
-let reduceMemory =
+let disableGcOptimizations =
   value & flag
   & info [ "reduce-ram-usage" ]
       ~doc:
@@ -83,7 +83,7 @@ let cmd =
   in
   ( const Main.main $ base $ comp $ diffPath $ threshold $ diffMask
     $ failOnLayout $ diffColor $ parsableOutput $ antialiasing $ ignoreRegions
-    $ diffLines $ reduceMemory,
+    $ diffLines $ disableGcOptimizations,
     Term.info "odiff" ~version:"3.0.0" ~doc:"Find difference between 2 images."
       ~exits:
         (Term.exit_info 0 ~doc:"on image match"

bin/node-bindings/odiff.d.ts

@@ -13,6 +13,8 @@ export type ODiffOptions = Partial<{
   antialiasing: boolean;
   /** If `true` reason: "pixel-diff" output will contain the set of line indexes containing different pixels */
   captureDiffLines: boolean;
+  /** If `true` odiff will use less memory but will be slower with larger images */
+  reduceRamUsage: boolean;
   /** An array of regions to ignore in the diff. */
   ignoreRegions: Array<{
     x1: number;

bin/node-bindings/odiff.js

@@ -50,6 +50,10 @@ function optionsToArgs(options) {
         setFlag("output-diff-lines", value);
         break;
 
+      case "reduceRamUsage":
+        setFlag("reduceRamUsage", value);
+        break;
+
       case "ignoreRegions": {
         const regions = value
           .map(