feat: example for README

.gitignore

@@ -2,5 +2,5 @@
 .idea/
 coverage/
 node_modules/
-test/results/routes.generated.txt
+test/results/*.generated.txt
 npm-debug.log

README.md

@@ -2,6 +2,25 @@
 
 express-print-routes prints the tree of all your [Express](http://expressjs.com) routes and middlewares to a file.
 
+```
+router                                                                                                         
+ ├── query                        *                                                           
+ ├── expressInit                  *                                                           
+ ├── logger                       *                                                           
+ ├── hpp                          *                                                           
+ ├── router                       /^\/api\/?(?=\/|$)/                                         
+ │   router                                                                                                    
+ │    ├── bound dispatch          /users/:id               GET
+ │    │    └── __getUser          /                        GET
+ │    │   
+ │    └── bound dispatch          /users/:id               POST
+ │         └── __updateUser       /                        POST
+ │        
+ │   
+ ├── serveStatic                  *                                                           
+ └── __handleError                *                                                           
+```
+
 ## Installation
 
 [![Build Status](https://img.shields.io/travis/analog-nico/express-print-routes/master.svg?style=flat-square)](https://travis-ci.org/analog-nico/express-print-routes)

test/results/example.expected.txt

@@ -0,0 +1,16 @@
+router                                                                                                         
+ ├── query                                         *                                                           
+ ├── expressInit                                   *                                                           
+ ├── logger                                        *                                                           
+ ├── hpp                                           *                                                           
+ ├── router                                        /^\/api\/?(?=\/|$)/                                         
+ │   router                                                                                                    
+ │    ├── bound dispatch                           /users/:id                                                  GET
+ │    │    └── __getUser                           /                                                           GET
+ │    │   
+ │    └── bound dispatch                           /users/:id                                                  POST
+ │         └── __updateUser                        /                                                           POST
+ │        
+ │   
+ ├── serveStatic                                   *                                                           
+ └── __handleError                                 *                                                           

test/spec/main.js

@@ -46,4 +46,35 @@ describe('The express-print-routes middleware', function () {
 
     });
 
+    it('should print example in README', function (done) {
+
+        var app = express();
+
+        app.use(function logger() {});
+        app.use(function hpp() {});
+
+        var router = express.Router();
+        app.use('/api', router);
+        router.get('/users/:id', function __getUser() {});
+        router.post('/users/:id', function __updateUser() {});
+
+        app.use(function serveStatic() {});
+        app.use(function __handleError() {});
+
+        printRoutes(app, path.join(__dirname, '../results/example.generated.txt'));
+
+
+        setTimeout(function () {
+
+            var expected = fs.readFileSync(path.join(__dirname, '../results/example.expected.txt'), 'utf8');
+            var generated = fs.readFileSync(path.join(__dirname, '../results/example.generated.txt'), 'utf8');
+
+            expect(generated).to.eql(expected);
+
+            done();
+
+        }, 100);
+
+    });
+
 });