Skip to content

Latest commit

 

History

History
86 lines (65 loc) · 2.33 KB

template.md

File metadata and controls

86 lines (65 loc) · 2.33 KB

{{name}}

{{#author}}

Author

{{author_name}}

Version

v{{version}}

{{#badges}}

Badges

{{#add_nodeico}}NPM{{/add_nodeico}}

{{#add_github_badges}}{{#add_github_stars}}GitHub stars{{/add_github_stars}} {{#add_github_forks}}GitHub forks{{/add_github_forks}} {{#add_github_issues}}GitHub issues{{/add_github_issues}} {{#add_github_license}}GitHub license{{/add_github_license}}{{/add_github_badges}} {{#add_travis}}Build Status{{/add_travis}} {{#add_coverage}}Coverage Status{{/add_coverage}} {{/badges}} {{/author}}

{{#license}}

License

{{license}} {{/license}}

Description

{{description}}

Installation

This is a Node.js module available through the npm registry. It can be installed using the npm or yarn command line tools.

{{#preferGlobal}}
npm install {{name}} --global
{{/preferGlobal}}
{{^preferGlobal}}
npm install {{name}} --save
{{/preferGlobal}}

{{#usage}}

Usage

{{{content}}}

{{/usage}}

Dependencies

{{#depDetails}}

  • {{name}}: {{description}} {{/depDetails}} {{^depDetails}} None {{/depDetails}}

Dev Dependencies

{{#devDepDetails}}

  • {{name}}: {{description}} {{/devDepDetails}} {{^devDepDetails}} None {{/devDepDetails}}

{{#scripts.test}}

Tests

npm install
npm test

{{/scripts.test}}

{{#testOutput}}

{{{testOutput}}}

{{/testOutput}}