Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Added node installation.

  • Loading branch information...
commit 3388dce2b6c3d5aa895e00712c1bdab0b39add94 1 parent 5256f0c
@cesutherland cesutherland authored
Showing with 9 additions and 3 deletions.
  1. +9 −3
@@ -17,10 +17,16 @@ API
* `equal(a, b, tolerance)` tests image type objects for equality; accepts tolerance in pixels.
* `diff(a, b)` performs an image diff on a and b, returning a - b.
* `noConflict()` removes imagediff from the global space for compatibility, returning imagediff.
-* `imageDataToPNG(imageData, outputFile, (callback))` renders the imageData to png in outputFile, firing an optional callback upon save. (Node only)
+* `imageDataToPNG(imageData, outputFile, [callback])` (node only) renders the imageData to png in outputFile with optional callback.
+js-imagediff is available through the npm. It uses [node-canvas]( which requires lib cairo to be installed.
+Install js-imagediff with `npm install -g imagediff`.
+### Command Line
-Command Line
* `imagediff [-e|equal] [-t|tolerance VALUE] FILE_A FILE_B` tests equality of two image files with an optional tolerance, printing 'true' or 'false'.
* `imagediff [-d|diff] FILE_A FILE_B OUTPUT_FILE` renders an imagediff between two files, saving as the output file.

0 comments on commit 3388dce

Please sign in to comment.
Something went wrong with that request. Please try again.