The pkgconfig data file ends up in /usr/local when compiling libvips from source

README.md

@@ -1,4 +1,4 @@
-# sharp
+# sharp
 
 _adj_
 
@@ -7,15 +7,17 @@ _adj_
 3. shrewd or astute: a sharp bargainer. 
 4. (Informal.) very stylish: a sharp dresser; a sharp jacket. 
 
-The typical use case for this high performance Node.js module is to convert a large JPEG image to smaller JPEG images of varying dimensions.
+The typical use case for this high speed Node.js module is to convert a large JPEG image to smaller JPEG images of varying dimensions.
 
 It is somewhat opinionated in that it only deals with JPEG images, always obeys the requested dimensions by either cropping or embedding and insists on a mild sharpen of the resulting image.
 
-Under the hood you'll find the blazingly fast [libvips](https://github.com/jcupitt/libvips) image processing library, originally created in 1989 at Birkbeck College and currently maintained by the University of Southampton. Speed is typically 25-30% faster than the imagemagick equivalent.
+Under the hood you'll find the blazingly fast [libvips](https://github.com/jcupitt/libvips) image processing library, originally created in 1989 at Birkbeck College and currently maintained by the University of Southampton.
+
+Performance is 4x-8x faster than the imagemagick equivalent, based mainly on the number of CPU cores available.
 
 ## Prerequisites
 
-Requires node-gyp and libvips-dev to build.
+Requires Node.js v0.8+, node-gyp and libvips-dev to build.
 
 	sudo npm install -g node-gyp
 	sudo apt-get install libvips-dev
@@ -26,7 +28,7 @@ Ubuntu 12.04 LTS:
 
 	sudo ln -s /usr/lib/pkgconfig/vips-7.26.pc /usr/lib/pkgconfig/vips.pc
 
-Ubuntu 13.04:
+Ubuntu 13.04 (64-bit):
 
 	sudo ln -s /usr/lib/x86_64-linux-gnu/pkgconfig/vips-7.28.pc /usr/lib/pkgconfig/vips.pc
 
@@ -36,28 +38,80 @@ Ubuntu 13.04:
 
 ## Usage
 
+	var sharp = require("sharp");
+
+### crop(inputPath, outputPath, width, height, callback)
+
+Scale and crop JPEG `inputPath` to `width` x `height` and write JPEG to `outputPath` calling `callback` when complete.
+
+Example:
+
 ```javascript
-var sharp = require("sharp");
 sharp.crop("input.jpg", "output.jpg", 300, 200, function(err) {
   if (err) {
     throw err;
   }
-  // output.jpg is cropped input.jpg
+  // output.jpg is a 300 pixels wide and 200 pixels high image
+  // containing a scaled and cropped version of input.jpg
 });
+```
+
+### embedWhite(inputPath, outputPath, width, height, callback)
+
+Scale and embed JPEG `inputPath` to `width` x `height` using a white canvas and write JPEG to `outputPath` calling `callback` when complete.
+
+```javascript
 sharp.embedWhite("input.jpg", "output.jpg", 200, 300, function(err) {
   if (err) {
     throw err;
   }
-  // output.jpg contains input.jpg embedded with a white border
+  // output.jpg is a 200 pixels wide and 300 pixels high image
+  // containing a scaled version of input.jpg embedded on a white canvas
 });
+```
+
+### embedBlack(inputPath, outputPath, width, height, callback)
+
+Scale and embed JPEG `inputPath` to `width` x `height` using a black canvas and write JPEG to `outputPath` calling `callback` when complete.
+
+```javascript
 sharp.embedBlack("input.jpg", "output.jpg", 200, 300, function(err) {
   if (err) {
     throw err;
   }
-  // output.jpg contains input.jpg embedded with a black border
+  // output.jpg is a 200 pixels wide and 300 pixels high image
+  // containing a scaled version of input.jpg embedded on a black canvas
 });
 ```
 
 ## Testing [![Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
 
+	npm install --dev sharp
 	npm test
+
+## Performance
+
+### AMD Athlon 4x core 3.3GHz 512KB L2
+
+* imagemagick x 5.55 ops/sec ±0.68% (31 runs sampled)
+* sharp x 24.49 ops/sec ±6.85% (64 runs sampled)
+
+### AWS t1.micro
+
+* imagemagick x 1.36 ops/sec ±0.96% (11 runs sampled)
+* sharp x 12.42 ops/sec ±5.84% (64 runs sampled)
+
+### AWS m1.medium
+
+* imagemagick x 1.38 ops/sec ±0.45% (11 runs sampled)
+* sharp x 12.66 ops/sec ±5.54% (65 runs sampled)
+
+### AWS c1.medium
+
+* imagemagick x 2.10 ops/sec ±0.67% (15 runs sampled)
+* sharp x 18.97 ops/sec ±10.54% (52 runs sampled)
+
+### AWS m3.xlarge
+
+* imagemagick x 4.46 ops/sec ±0.33% (26 runs sampled)
+* sharp x 28.89 ops/sec ±7.75% (74 runs sampled)

binding.gyp

@@ -2,7 +2,10 @@
   'targets': [{
     'target_name': 'sharp',
     'sources': ['src/sharp.cc'],
-    'libraries': ['<!@(PKG_CONFIG_PATH="/usr/lib/pkgconfig" pkg-config --libs glib-2.0 vips)'],
+    'libraries': [
+      '<!@(PKG_CONFIG_PATH="/usr/local/lib/pkgconfig" pkg-config --libs vips)',
+      '<!@(PKG_CONFIG_PATH="/usr/lib/pkgconfig" pkg-config --libs vips)'
+    ],
     'include_dirs': [
       '/usr/include/glib-2.0',
       '/usr/lib/glib-2.0/include',

package.json

@@ -1,30 +1,31 @@
 {
   "name": "sharp",
-  "version": "0.0.1",
-  "main": "./build/Release/sharp",
+  "version": "0.0.3",
+  "main": "index.js",
   "description": "High performance Node.js module to resize JPEG images using the libvips image processing library",
   "repository": {
     "type": "git",
     "url": "git://github.com/lovell/sharp"
   },
   "devDependencies": {
-    "imagemagick": "*"
+    "imagemagick": "*",
+    "benchmark": "*"
   },
   "scripts": {
     "test": "node tests/perf.js"
   },
   "engines": {
-    "node": "*"
+    "node": ">=0.8"
   },
   "keywords": [
     "jpeg",
     "resize",
     "thumbnail",
-	"sharpen",
-	"crop",
-	"embed",
+    "sharpen",
+    "crop",
+    "embed",
     "libvips",
-	"fast"
+    "fast"
   ],
   "author": "Lovell Fuller",
   "license": "Apache 2.0"

tests/perf.js

@@ -1,42 +1,44 @@
 var sharp = require("../index");
 var imagemagick = require("imagemagick");
 var assert = require("assert");
+var Benchmark = require("benchmark");
 
-// http://www.flickr.com/photos/grizdave/2569067123/
-var input = __dirname + "/2569067123_aca715a2ee_o.jpg";
+var input = __dirname + "/2569067123_aca715a2ee_o.jpg"; // http://www.flickr.com/photos/grizdave/2569067123/
 var output = __dirname + "/output.jpg";
-
 var width = 640;
 var height = 480;
 
-// imagemagick
-var time = process.hrtime();
-imagemagick.resize({
-  srcPath: input,
-  dstPath: output,
-  quality: 0.75,
-  width: width,
-  height: height
-}, function(err) {
-  if (err) {
-    throw err;
+var suite = new Benchmark.Suite;
+suite.add("imagemagick", {
+  "defer": true,
+  "fn": function(deferred) {
+    imagemagick.resize({
+      srcPath: input,
+      dstPath: output,
+      quality: 0.75,
+      width: width,
+      height: height
+    }, function(err) {
+      if (err) {
+        throw err;
+      } else {
+        deferred.resolve();
+      }
+    });
   }
-  var diff = process.hrtime(time);
-  imagemagickTime = diff[0] * 1e9 + diff[1];
-  console.log("imagemagick took %d nanoseconds", imagemagickTime);
-
-  // sharp
-  time = process.hrtime();
-  sharp.crop(input, output, width, height, function(err) {
-    if (err) {
-      throw err;
-    }
-    diff = process.hrtime(time);
-	var sharpTime = diff[0] * 1e9 + diff[1];
-    console.log("sharp took %d nanoseconds", sharpTime);
-
-	// diff
-	assert(sharpTime < imagemagickTime, "sharp was blunt");
-	console.log("sharp was %d%% faster", (imagemagickTime - sharpTime) / imagemagickTime * 100);
-  });
-});
+}).add("sharp", {
+  "defer": true,
+  "fn": function(deferred) {
+    sharp.crop(input, output, width, height, function(err) {
+      if (err) {
+        throw err;
+      } else {
+        deferred.resolve();
+      }
+    });
+  }
+}).on("cycle", function(event) {
+  console.log(String(event.target));
+}).on("complete", function() {
+  assert(this.filter("fastest").pluck("name") == "sharp");
+}).run();