Update readme with multi-file documentation example

- Also add test-manual with examples for confirming functionality

Author: tmcw

README.md

@@ -23,22 +23,41 @@ $ npm install --save-dev gulp-documentation
 ## Example
 
 ```js
-var documentation = require('gulp-documentation'),
+var gulpDocumentation = require('gulp-documentation'),
     gulp = require('gulp');
 
+/**
+ * Out of the box, you can generate JSON, HTML, and Markdown documentation
+ */
 gulp.task('documentation', function () {
 
+  // Generating README documentation
   gulp.src('./index.js')
-    .pipe(documentation({ format: 'md' }))
+    .pipe(gulpDocumentation({ format: 'md' }))
     .pipe(gulp.dest('md-documentation'));
 
+  // Generating a pretty HTML documentation site
   gulp.src('./index.js')
-    .pipe(documentation({ format: 'html' }))
+    .pipe(gulpDocumentation({ format: 'html' }))
     .pipe(gulp.dest('html-documentation'));
 
+  // Generating raw JSON documentation output
   gulp.src('./index.js')
-    .pipe(documentation({ format: 'json' }))
+    .pipe(gulpDocumentation({ format: 'json' }))
     .pipe(gulp.dest('json-documentation'));
 
+});
+
+/**
+ * Generate documentation for multiple files using normal glob syntax.
+ * Note that this generates one documentation output, so that it can
+ * easily cross-reference and use types.
+ */
+gulp.task('documentation', function () {
+
+  gulp.src('./src/*.js')
+    .pipe(gulpDocumentation({ format: 'md' }))
+    .pipe(gulp.dest('md-documentation'));
+
 });
 ```

test-manual/multi/gulpfile.js

@@ -0,0 +1,18 @@
+var gulpDocumentation = require('../../'),
+  gulp = require('gulp');
+
+gulp.task('documentation', function () {
+
+  gulp.src('./src/*.js')
+    .pipe(gulpDocumentation({ format: 'md' }))
+    .pipe(gulp.dest('md-documentation'));
+
+});
+
+gulp.task('documentation-shallow', function () {
+
+  gulp.src('./src/*.js')
+    .pipe(gulpDocumentation({ shallow: true, format: 'md' }))
+    .pipe(gulp.dest('md-documentation'));
+
+});

test-manual/multi/md-documentation/API.md

@@ -0,0 +1,11 @@
+# aFunction
+
+this is a
+
+# bFunction
+
+this is b
+
+# cFunction
+
+this is c

test-manual/multi/src/a.js

@@ -0,0 +1,2 @@
+/** this is a */
+function aFunction() {}

test-manual/multi/src/b.js

@@ -0,0 +1,2 @@
+/** this is b */
+function bFunction() {}

test-manual/multi/src/c.js

@@ -0,0 +1,2 @@
+/** this is c */
+function cFunction() {}