Ship

Author: tmcw

README.md

@@ -3,3 +3,34 @@
 Use [gulp](http://gulpjs.com/) with
 [documentation](https://github.com/documentationjs/documentation)
 to generate great documentation for your JavaScript projects.
+
+| name | description |
+| ---- | ----------- |
+| `options` | output options |
+| `options.format` | either 'html', 'md', 'json', or 'docset' |
+| `options.filename` | custom filename for md or json output |
+
+Returns `stream.Transform`
+
+## Example
+
+```js
+var documentation = require('documentation'),
+    gulp = require('gulp');
+
+gulp.task('documentation', function () {
+
+  gulp.src('./index.js')
+    .pipe(documentation({ format: 'md' }))
+    .pipe(gulp.dest('md-documentation'));
+
+  gulp.src('./index.js')
+    .pipe(documentation({ format: 'html' }))
+    .pipe(gulp.dest('html-documentation'));
+
+  gulp.src('./index.js')
+    .pipe(documentation({ format: 'json' }))
+    .pipe(gulp.dest('json-documentation'));
+
+});
+```

example/gulpfile.js

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