Snippets for your GitHub project's readme.
verb and generator-verb depend on this library.
(Table of contents generated by [verb])
Install with npm
npm i readme-includes --save-dev
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') %}
See an up-to-date list of the includes in the templates/example.md directory:
Usage examples for all of the included templates
Include:
{%= include("twitter.md") %}
Include:
{%= include("tests.md") %}
Include:
{%= include("tests-grunt.md") %}
Include:
{%= include("run-verb.md") %}
Include:
{%= include("maintainers.md") %}
Include:
{%= include("license-mit.md") %}
Include:
{%= include("issues.md") %}
Include:
{%= include("install.md") %}
Include:
{%= include("install-npm.md") %}
Include:
{%= include("install-grunt.md") %}
Include:
{%= include("install-global.md") %}
Include:
{%= include("install-bower.md") %}
Include:
{%= include("history.md") %}
Include:
{%= include("github.md") %}
Include:
{%= include("footer.md") %}
Include:
{%= include("download.md") %}
Include:
{%= include("contributors.md") %}
Include:
{%= include("contributing.md") %}
Include:
{%= include("contributing-extra.md") %}
Include:
{%= include("contributing-detailed.md") %}
Include:
{%= include("clone.md") %}
Include:
{%= include("cli.md") %}
Include:
{%= include("build-docs.md") %}
Include:
{%= include("benchmarks.md") %}
Include:
{%= include("authors.md") %}
Include:
{%= include("author.md") %}
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Copyright (c) 2014-2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on May 14, 2015.