# gulp-contribs

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

Latest version **0.0.3** (published 2015-07-20) · 0 weekly downloads

## Install

```sh
npm install gulp-contribs
pnpm add gulp-contribs
yarn add gulp-contribs
bun add gulp-contribs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-07-20 |
| First published | 2014-03-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Shane Osbourne |
| Maintainers | shakyshane |
| Keywords | gulpplugin, contributors |

## Links

- npm: https://www.npmjs.com/package/gulp-contribs
- Repository: https://github.com/shakyshane/gulp-contribs
- Issues: https://github.com/shakyshane/gulp-contribs/issues
- npm.io page: https://npm.io/package/gulp-contribs

## Dependencies (2)

- [through2](https://npm.io/package/through2.md) ~0.4.1
- [gulp-util](https://npm.io/package/gulp-util.md) ~2.2.14

## Recent versions

- 0.0.3 (latest) — 2015-07-20
- 0.0.2 — 2014-03-02
- 0.0.1 — 2014-03-02

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

---
_Source: https://npm.io/package/gulp-contribs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._