verb-repo-helpers/README.md

Commonly used helpers for adding repository-related data to templates in verb projects.

# verb-repo-helpers [![NPM version](https://img.shields.io/npm/v/verb-repo-helpers.svg?style=flat)](https://www.npmjs.com/package/verb-repo-helpers) [![NPM monthly downloads](https://img.shields.io/npm/dm/verb-repo-helpers.svg?style=flat)](https://npmjs.org/package/verb-repo-helpers)  [![NPM total downloads](https://img.shields.io/npm/dt/verb-repo-helpers.svg?style=flat)](https://npmjs.org/package/verb-repo-helpers) [![Linux Build Status](https://img.shields.io/travis/verbose/verb-repo-helpers.svg?style=flat&label=Travis)](https://travis-ci.org/verbose/verb-repo-helpers) [![Windows Build Status](https://img.shields.io/appveyor/ci/verbose/verb-repo-helpers.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/verbose/verb-repo-helpers)

> Commonly used helpers for adding repository-related data to templates in verb projects.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save verb-repo-helpers
```

Install with [yarn](https://yarnpkg.com):

```sh
$ yarn add verb-repo-helpers
```

## Usage

```js
var verb = require('verb');
var helpers = require('verb-repo-helpers');

var app = verb();
app.use(helpers);
```

## Generator usage

In your verb generator:

```js
module.exports = function(app) {
  app.use(require('verb-repo-helpers'));
};
```

## About

### Related projects

* [verb-defaults](https://www.npmjs.com/package/verb-defaults): Plugin for setting basic defaults in verb projects. | [homepage](https://github.com/verbose/verb-defaults "Plugin for setting basic defaults in verb projects.")
* [verb-readme-generator](https://www.npmjs.com/package/verb-readme-generator): Generate your project's readme with verb. Requires verb v0.9.0 or higher. | [homepage](https://github.com/verbose/verb-readme-generator "Generate your project's readme with verb. Requires verb v0.9.0 or higher.")
* [verb-repo-data](https://www.npmjs.com/package/verb-repo-data): Verb plugin that adds repository and package.json data to the context for rendering templates. | [homepage](https://github.com/verbose/verb-repo-data "Verb plugin that adds repository and package.json data to the context for rendering templates.")
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Contributors

| **Commits** | **Contributor** |  
| --- | --- |  
| 24 | [jonschlinkert](https://github.com/jonschlinkert) |  
| 5  | [doowb](https://github.com/doowb) |  

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 26, 2017._