fix examples with redis and better readme

Author: goenning

.DS_Store

@@ -4,6 +4,7 @@ npm-debug.log*
 pids
 *.pid
 *.seed
+*.rdb
 lib-cov
 coverage
 .nyc_output

.gitignore

@@ -2,23 +2,64 @@
 
 Node.js implementation of Stack Exchange's MiniProfiler
 
-[![Build Status](https://travis-ci.org/goenning/miniprofiler-node.png)](https://travis-ci.org/goenning/miniprofiler-node)
-[![Coverage Status](https://coveralls.io/repos/github/goenning/miniprofiler-node/badge.svg?branch=master)](https://coveralls.io/github/goenning/miniprofiler-node?branch=master)
+[![Build](https://travis-ci.org/goenning/miniprofiler-node.svg)](https://travis-ci.org/goenning/miniprofiler-node)
+[![Coverage](https://coveralls.io/repos/github/goenning/miniprofiler-node/badge.svg?branch=master)](https://coveralls.io/github/goenning/miniprofiler-node?branch=master)
 ![Dependencies](https://david-dm.org/goenning/miniprofiler-node.svg)
+![devDependencies](https://david-dm.org/goenning/miniprofiler-node.svg#info=devDependencies)
+
 ### This is working, but not yet considered production ready. Use with caution.
 
-# requirements
+## Installation (via [npm](https://npmjs.org/package/miniprofiler))
+
+```bash
+$ npm install miniprofiler
+```
+
+## Usage
+
+### Simple usage using express.js
+
+`server.js`
+
+```javascript
+var express = require('express')
+  , miniprofiler = require('miniprofiler')
+  , app = express();
+
+app.set('view engine', 'pug');
+app.use(miniprofiler.profile());
+
+app.get('/', function(req, res) {
+  req.miniprofiler.step('Step 1', function() {
+    req.miniprofiler.step('Step 2', function() {
+      res.render('home');
+    });
+  });
+});
+
+app.listen(8080);
+```
+
+`home.pug`
 
-Currently requires express and connect to run, because it uses `res.on('header', f)` to trigger storing of data, which is a connect thing.
+```javascript
+doctype html
+html
+  head
+    title MiniProfiler Node.js Example
+  body
+    h1 Home Page
+    | !{miniprofiler.include()}
+```
 
-# usage
+When visiting `localhost:8080`, you should see this.
 
-Clone this repo into your project's node_modules directory. You can also install from npm, but the package may be outdated: https://www.npmjs.org/package/miniprofiler.
+![](/examples/images/example0.png)
 
-Then see [examples/express/server.js](/examples/express/server.js) for example use.
+See [examples/express.js](/examples/express.js) for more examples.
 
-![](/examples/example1.png)
-![](/examples/example2.png)
+![](/examples/images/example1.png)
+![](/examples/images/example2.png)
 
 # Want to help?
 
@@ -29,6 +70,3 @@ Things to do:
 - storing of client timings on first result postback (there's a todo in the `results` function about where to do this)
 - document more things
 - add providers for pg, mongodb, mysql, redis and more
-- add coverage badge
-- add npm package version badge
-- add dependencies status badge

README.md

@@ -1,4 +1,4 @@
-var miniprofiler = require('../../lib/miniprofiler.js');
+var miniprofiler = require('../lib/miniprofiler.js');
 var pg = require('pg');
 var redis = require('redis');
 
@@ -10,29 +10,28 @@ app.use(miniprofiler.profile());
 app.use(miniprofiler.for.pg(pg));
 app.use(miniprofiler.for.redis(redis));
 
+	var redisClient = redis.createClient();
+
 app.set('view engine', 'pug');
 app.set('views', './examples/views');
 
 app.get('/', function(req, res) {
-	res.render('home');
+  req.miniprofiler.step('Step 1', function() {
+    req.miniprofiler.step('Step 2', function() {
+      res.render('home');
+    });
+  });
 });
 
 app.get('/js-sleep', function(req, res) {
-	var waitBeforeRender = function(ms) {
-		setTimeout(function() {
-			res.render('home');
-		}, ms());
-	};
-
-	req.miniprofiler.timeQuery('custom', 'Sleeping...', waitBeforeRender, function() {
-		return 300;
-	});
+	req.miniprofiler.timeQuery('custom', 'Sleeping...', setTimeout, function() {
+		res.send();
+	}, 300);
 });
 
 app.get('/redis-set-get', function(req, res) {
-	var redisClient = redis.createClient();
   redisClient.set('customer', '[email protected]', function() {
-    redisClient.get('key', function(err, reply) {
+    redisClient.get('customer', function(err, reply) {
       res.render('home');
     });
   });
@@ -48,7 +47,6 @@ app.get('/pg-sleep', function(req, res) {
 });
 
 app.get('/all', function(req, res) {
-	var redisClient = redis.createClient();
   req.miniprofiler.step('Waiting 1 second', function() {
 
     pg.connect(connString, function(err, pgClient, done) {

examples/example1.png

@@ -1,5 +1,5 @@
 var http = require('http');
-var miniprofiler = require('../../lib/miniprofiler.js');
+var miniprofiler = require('../lib/miniprofiler.js');
 
 var profile = miniprofiler.profile();