gulp-contribs

Give your open-source contributors some credit - automatically list them in your readme.md, or any where else.

Usage

Install it locally to your project.

npm install gulp-contribs

Example

With no parameters, the default start and end points (## Contributors & ## License) will be used. Check this example

1var gulp = require('gulp');
2var contribs = require('gulp-contribs');
3
4gulp.task('contribs', function () {
5    gulp.src('README.md')
6        .pipe(contribs())
7        .pipe(gulp.dest("./"))
8});

Configure

To configure where abouts in your file you want to 'wedge' the contributors list, just pass start and end strings like this.

Example: If you want the list to be wedged in between ## Contributors List and ## License in your files, you'd do it like this.

1var gulp = require('gulp');
2var contribs = require('gulp-contribs');
3
4gulp.task('contribs', function () {
5    gulp.src('README.md')
6        .pipe(contribs("## Contributors List", "## License"))
7        .pipe(gulp.dest("./"))
8});

License

Copyright (c) 2013 Shane Osbourne Licensed under the MIT license.