update readme

Author: joanaz

MMM-Smile.js

@@ -12,12 +12,12 @@ Module.register('MMM-Smile', {
   defaults: {
     // recognition interval in ms, default to 8 hours
     interval: 8 * 60 * 60 * 1000,
+    // test running time in seconds
+    testRunTime: 60,
     // smile time in seconds
     smileLength: 5,
     // use pi camera by default
-    usePiCam: true,
-    // test running time in seconds
-    testRunTime: 60
+    usePiCam: true
   },
 
   start: function() {
@@ -91,10 +91,6 @@ Module.register('MMM-Smile', {
     if (this.gitUrl != '') {
       var img = document.createElement("img");
       img.src = this.gifUrl
-
-      // image.width = this.config.imageSize.toString();
-      // image.height = this.config.imageSize.toString();
-
       wrapper.appendChild(img);
     }
 

README.md

@@ -1,18 +1,26 @@
-# MMM-Emotion-Detection
-This is an extension for the [MagicMirror](https://github.com/MichMich/MagicMirror). It does smile test for the current user.
+# MMM-Smile
 
-Algorithm from [emotion-detection](https://github.com/liy9393/emotion-detection)
+This is a module for the [MagicMirror](https://github.com/MichMich/MagicMirror). It displays a random funny GIF on the magic mirror, then conducts smiling test for the current user by detecting smiling faces on camera using Haar Cascades, and saves the images in the log folder. 
+
+Reference: [REAL-TIME SMILE DETECTION IN PYTHON OPENCV](http://pushbuttons.io/blog/2015/4/27/smile-detection-in-python-opencv).
 
 ## Usage
 
-The entry in config.js can look like the following. (NOTE: You only have to add the variables to config if want to change its standard value.)
+The entry in config.js can look like the following. (NOTE: You only have to add the variables to config if you want to change its standard value.)
 
 ```
 {
-	module: 'MMM-Emotion-Detection',
+	module: 'MMM-Smile',
+    position: "middle_center",
 	config: {
-		// recognition intervall in seconds
-		interval: 2,
+        // recognition interval in ms, default to 8 hours
+        interval: 8 * 60 * 60 * 1000,
+        // total test running time in seconds
+        testRunTime: 120,
+        // the smiling period in seconds in order to pass the test
+        smileLength: 5,
+        // use pi camera by default; set it to false for laptop camera
+        usePiCam: true
 	}
 }
 ```
@@ -21,6 +29,8 @@ The entry in config.js can look like the following. (NOTE: You only have to add
 ## Dependencies
 - [python-shell](https://www.npmjs.com/package/python-shell) (installed via `npm install`)
 - [OpenCV](http://opencv.org) 
+    - Mac: `brew install opencv`
 	- Linux: `sudo apt-get install libopencv-dev python-opencv` 
-	- Mac: `brew install opencv`
+    - Raspberry Pi: follow this [guide](http://www.pyimagesearch.com/2016/04/18/install-guide-raspberry-pi-3-raspbian-jessie-opencv-3/), will take few hours
+	
 

node_helper.js

@@ -2,7 +2,6 @@
 const NodeHelper = require('node_helper');
 const request = require('request');
 const PythonShell = require('python-shell');
-// this.pythonStarted = false
 
 module.exports = NodeHelper.create({
 

package.json

@@ -4,21 +4,23 @@
   "description": "Smile Test for the Magic Mirror.",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/paviro/MMM-Facial-Recognition"
+    "url": "git+https://github.com/joanaz/MMM-Smile"
   },
   "keywords": [
     "magic mirror",
     "smart mirror",
-    "Facial expression recognition",
-    "module"
+    "module",
+    "magic mirror module",
+    "facial expression recognition",
+    "smile detection"
   ],
-  "author": "Paul-Vincent Roll",
-  "contributors": "https://github.com/paviro/MMM-Facial-Recognition/graphs/contributors",
+  "author": "Joanna Zhang",
+  "contributors": "https://github.com/joanaz/MMM-Smile/graphs/contributors",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/paviro/MMM-Facial-Recognition/issues"
+    "url": "https://github.com/joanaz/MMM-Smile/issues"
   },
-  "homepage": "https://github.com/paviro/MMM-Facial-Recognition#readme",
+  "homepage": "https://github.com/joanaz/MMM-Smile#readme",
   "dependencies": {
     "python-shell": "latest"
   }