From 7aaea279055992c4ba1b766dd0c3dca81133e95c Mon Sep 17 00:00:00 2001
From: Justin Wetherell <phishman3579@gmail.com>
Date: Wed, 20 Nov 2013 17:23:18 +0000
Subject: [PATCH] Updated the readme

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2f8cbc9..8a6215e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,33 @@
 android-motion-detection
 ========================
 
-Android code to detection motion by comparing two images.
+Android code to detection motion from by comparing two pictures.
+
+## Introduction
+
+Android code to detection motion from by comparing two pictures. It comes with an Activity that initializes a camera and grabs two pictures and compares them.
+
+* Created by Justin Wetherell
+* github: http://github.com/phishman3579/android-motion-detection
+* e-mail: phishman3579@gmail.com
+* Twitter: @phishman3579
+
+## Details
+
+You essentially have to override an onPreviewFrame(byte[] data, Camera cam) method and convert from the default YUV to RGB:
+
+    int[] rgb = ImageProcessing.decodeYUV420SPtoRGB(data, width, height);
+
+Create an object which you'll use for motion detection code:
+
+    IMotionDetection detector = new RgbMotionDetection();
+
+Call the detect() method passing in the parameters obtained above.
+
+    boolean detected = detector.detect(rgb, width, height)
+
+If the boolean "detected" variable is true then it has detected motion.
+
+The RGB detection code is located in RgbMotionDetection.java class. The image processing code is located in ImageProcessing.java static class. The Activity to tie it all together is in MotionDetectionActivity.java.
+
+I have created a MotionDetection class that detects motion comparing RGB values called RgbMotionDetection.java, a class that detects motion comparing Luminance values called LumaMotionDetection.java, and a class that detects motion comparing avergae Luminance values in regions called AggregateLumaMotionDetection.java.