https://github.com/shakyshane/gulp-contribs

Give your open-source contributors some credit - automatically list them in your readme.md, or anywhere else.
https://github.com/shakyshane/gulp-contribs

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/shakyshane/gulp-contribs
• Owner: shakyShane
• License: mit
• Created: 2014-03-02T01:19:33.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-07-20T19:01:29.000Z (over 9 years ago)
• Last Synced: 2024-11-14T10:37:04.255Z (about 2 months ago)
• Language: JavaScript
• Size: 109 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# gulp-contribs [![Build Status](https://travis-ci.org/shakyShane/gulp-contribs.png?branch=master)](https://travis-ci.org/shakyShane/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](https://github.com/shakyShane/browser-sync#contributors)

```js

var gulp = require('gulp');

var contribs = require('gulp-contribs');

gulp.task('contribs', function () {

    gulp.src('README.md')

        .pipe(contribs())

        .pipe(gulp.dest("./"))

});

```

## 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.

```js

var gulp = require('gulp');

var contribs = require('gulp-contribs');

gulp.task('contribs', function () {

    gulp.src('README.md')

        .pipe(contribs("## Contributors List", "## License"))

        .pipe(gulp.dest("./"))

});

```

## License

Copyright (c) 2013 Shane Osbourne

Licensed under the MIT license.