dodekeract/generator-ci

View on GitHub
generators/app/templates/README.md

Summary

Maintainability
Test Coverage
# <%= projectName %>

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
[![Build Status](https://api.travis-ci.org/<%= githubUsername %>/<%= projectName %>.svg)](https://travis-ci.org/<%= githubUsername %>/<%= projectName %>/)
[![Code Climate](https://codeclimate.com/github/<%= githubUsername %>/<%= projectName %>/badges/gpa.svg)](https://codeclimate.com/github/<%= githubUsername %>/<%= projectName %>)
[![Coverage Status](https://coveralls.io/repos/<%= githubUsername %>/<%= projectName %>/badge.svg)](https://coveralls.io/github/<%= githubUsername %>/<%= projectName %>)
[![NPM Downloads](https://img.shields.io/npm/dm/<%= projectName %>.svg)](https://npmjs.com/package/<%= projectName %>)
[![NPM Dependencies](https://david-dm.org/<%= githubUsername %>/<%= projectName %>.svg)](https://david-dm.org/<%= githubUsername %>/<%= projectName %>)
[![Code Documentation](https://inch-ci.org/github/<%= githubUsername %>/<%= projectName %>.svg)](https://inch-ci.org/github/<%= githubUsername %>/<%= projectName %>)

<%= shortDescription %>

## Installation
**Basic**: ````npm install <%= projectName %>````

**As Dependency**: ````npm install <%= projectName %> --save````

**Require in Node**: ````var <%= projectName %> = require('<%= projectName %>');````