From a82c66fa25090cfc4a8d0d270cfd549c4cbe8e30 Mon Sep 17 00:00:00 2001
From: Peter Braden <peterbraden@peterbraden.co.uk>
Date: Thu, 19 Jan 2012 00:07:06 -0800
Subject: [PATCH] readme etc

---
 README.md    | 26 +++++++++++++++++++++++++-
 package.json |  2 +-
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5f654e9..c261ab5 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,34 @@
 You'll need OpenCV installed. I'm using v2.2 because I couldn't get 2.3 to compile, but it should theoretically work with 2.3
 
 Then:
+
+
+        npm install opencv
+
+
+Or to build the repo:
+
+
         node-waf configure && node-waf build
 
 
-TODO: npm install opencv
+## Examples
+
+### Face Detection
+
+
+        var im = new cv.Image("./examples/mona.jpg")
+        , face_cascade = new cv.CascadeClassifier("./examples/haarcascade_frontalface_alt.xml")
+
+        var faces = face_cascade.detectMultiScale(im, 1.1, 2, [30, 30])
+
+        for (var i=0;i<faces.length; i++){
+          var x = faces[i]
+          im.ellipse(x.x + x.width/2, x.y + x.height/2, x.width/2, x.height/2);
+        }
+        im.save('./out.jpg');
+
+Warning: API is likely to change! (I want to make it async)
 
 
 ## WIP
diff --git a/package.json b/package.json
index b4e413f..9e304b3 100644
--- a/package.json
+++ b/package.json
@@ -12,5 +12,5 @@
  , "scripts": {
    "preinstall": "node-waf configure build"
  }
- , "main": "./lib/opencv",
+ , "main": "./lib/opencv"
 }
\ No newline at end of file