Home

Awesome

readme-includes NPM version

Snippets for your GitHub project's readme.

verb and generator-verb depend on this library.

Table of contents

<!-- toc -->

(Table of contents generated by [verb])

<!-- tocstop -->

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:

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

Contributing

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

Author


License

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


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