qiu8310/generator-nody

View on GitHub
app/templates/_README.md._tpl

Summary

Maintainability
Test Coverage
# <%= npmname %>
[![NPM version](https://badge.fury.io/js/<%= npmname %>.svg)](https://npmjs.org/package/<%= npmname %>)<% if (userData.github) { %>
[![GitHub version][git-tag-image]][project-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][daviddm-url]][daviddm-image]<% if (docModule) { %>
[![Inline docs][doc-image]][doc-url]<% } %>
[![Code Climate][climate-image]][climate-url]<% if (coverallsModule) { %>
[![Coverage Status][coveralls-image]][coveralls-url]<% } %>
<% } %>


<%= props.description %>

<% if (userData.github) { %><% if (docModule) { %>
[Github Repo][project-url]

[JSDOC Generated Document](http://<%= userData.github.login %>.github.io/<%= slugname %>)
<% } %><% } %>

## Install

<% if (bowerModule) { %>
### Node.js

```bash
npm install --save <%= npmname %>
```

### Browser

```bash
bower install --save <%= npmname %>
```

<% } else { %>

```bash
npm install --save <%= npmname %>
```

<% } %>

## Usage

```javascript
var <%= safeSlugname %> = require('<%= npmname %>');
<%= safeSlugname %>(); // "awesome"
```

## API

_(Coming soon)_


## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [gulp](http://gulpjs.com/).


## Reference
* [CI Test for Browser](https://ci.testling.com/) - Run your browser tests on every push, demo project [js-traverse](https://github.com/substack/js-traverse)
* [GA on Github](https://github.com/igrigorik/ga-beacon) - Google Analytics collector-as-a-service (using GA measurement protocol).
* [idiomatic.js](https://github.com/rwaldron/idiomatic.js) - Principles of Writing Consistent, Idiomatic JavaScript
* [Use jsdoc](http://usejsdoc.org/index.html)
* [Using the ES6 transpiler Babel on Node.js](http://www.2ality.com/2015/03/babel-on-node.html)
* [Node Collection](https://github.com/npm/newww/issues/313)
  - [http://tools.ampersandjs.com/](http://tools.ampersandjs.com/)
  - [https://github.com/sindresorhus/awesome-nodejs](https://github.com/sindresorhus/awesome-nodejs)
  - [https://www.npmjs.com/package/frontend-npm-goodies](https://www.npmjs.com/package/frontend-npm-goodies)
  - [https://github.com/Raynos/http-framework/wiki/Modules#response](https://github.com/Raynos/http-framework/wiki/Modules#response)
  - [https://github.com/npm-dom](https://github.com/npm-dom)
  - [https://www.npmjs.com/package/mad-science-modules](https://www.npmjs.com/package/mad-science-modules)
  - [https://www.npmjs.com/package/npm-collection-language-tools#readme](https://www.npmjs.com/package/npm-collection-language-tools#readme)
  - And more...


## History

[CHANGELOG](CHANGELOG.md)


## License

Copyright (c) <%= currentYear %> <%= userData.name %>. Licensed under the <%= props.license %> license.


<% if (userData.github) { %><% if (docModule) { %>
[doc-url]: http://inch-ci.org/github/<%= userData.github.login %>/<%= slugname %>
[doc-image]: http://inch-ci.org/github/<%= userData.github.login %>/<%= slugname %>.svg?branch=master<% } %>
[project-url]: <%= userData.project_url %>
[git-tag-image]: http://img.shields.io/github/tag/<%= userData.github.login %>/<%= slugname %>.svg
[climate-url]: https://codeclimate.com/github/<%= userData.github.login %>/<%= slugname %>
[climate-image]: https://codeclimate.com/github/<%= userData.github.login %>/<%= slugname %>/badges/gpa.svg
[travis-url]: https://travis-ci.org/<%= userData.github.login %>/<%= slugname %>
[travis-image]: https://travis-ci.org/<%= userData.github.login %>/<%= slugname %>.svg?branch=master
[daviddm-url]: https://david-dm.org/<%= userData.github.login %>/<%= slugname %>.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/<%= userData.github.login %>/<%= slugname %><% if (coverallsModule) { %>
[coveralls-url]: https://coveralls.io/r/<%= userData.github.login %>/<%= slugname %>
[coveralls-image]: https://coveralls.io/repos/<%= userData.github.login %>/<%= slugname %>/badge.png<% } %>
<% } %>