readme-includes

Snippets for your GitHub project's readme.

verb and generator-verb depend on this library.

Table of contents

• Install
• Usage
• Included templates
• Examples
• Related projects
• Contributing
• Author
• License

(Table of contents generated by [verb])

Install

Install with npm

npm i readme-includes --save-dev

Usage

Any template from this library can be included in another template using the {%= include() %} tag.

Example

// add installation instructions to a readme, like those above
{%= include('install-npm') %}

Included templates

See an up-to-date list of the includes in the templates/example.md directory:

• twitter.md
• tests.md
• tests-grunt.md
• run-verb.md
• maintainers.md
• license-mit.md
• issues.md
• install.md
• install-npm.md
• install-grunt.md
• install-global.md
• install-bower.md
• history.md
• github.md
• footer.md
• download.md
• contributors.md
• contributing.md
• contributing-extra.md
• contributing-detailed.md
• clone.md
• cli.md
• build-docs.md
• benchmarks.md
• authors.md
• author.md

Examples

Usage examples for all of the included templates

twitter.md

Include:

{%= include("twitter.md") %}

tests.md

Include:

{%= include("tests.md") %}

tests-grunt.md

Include:

{%= include("tests-grunt.md") %}

run-verb.md

Include:

{%= include("run-verb.md") %}

maintainers.md

Include:

{%= include("maintainers.md") %}

license-mit.md

Include:

{%= include("license-mit.md") %}

issues.md

Include:

{%= include("issues.md") %}

install.md

Include:

{%= include("install.md") %}

install-npm.md

Include:

{%= include("install-npm.md") %}

install-grunt.md

Include:

{%= include("install-grunt.md") %}

install-global.md

Include:

{%= include("install-global.md") %}

install-bower.md

Include:

{%= include("install-bower.md") %}

history.md

Include:

{%= include("history.md") %}

github.md

Include:

{%= include("github.md") %}

footer.md

Include:

{%= include("footer.md") %}

download.md

Include:

{%= include("download.md") %}

contributors.md

Include:

{%= include("contributors.md") %}

contributing.md

Include:

{%= include("contributing.md") %}

contributing-extra.md

Include:

{%= include("contributing-extra.md") %}

contributing-detailed.md

Include:

{%= include("contributing-detailed.md") %}

clone.md

Include:

{%= include("clone.md") %}

cli.md

Include:

{%= include("cli.md") %}

build-docs.md

Include:

{%= include("build-docs.md") %}

benchmarks.md

Include:

{%= include("benchmarks.md") %}

authors.md

Include:

{%= include("authors.md") %}

author.md

Include:

{%= include("author.md") %}

Related projects

• template: Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… more
• verb: Documentation generator for GitHub projects. Extremely powerful, easy to use, can generate anything from API… more

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014-2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on May 14, 2015.