UNPKG

create-readme

Version:

Automatically creates README.md based on package.json and other existing files.

73 lines (72 loc) 2.64 kB
{ "npm-version": { "name": "npm version", "img": "https://badge.fury.io/js/{{name}}.svg", "url": "https://npmjs.org/package/{{name}}" }, "travis": { "name": "build status", "img": "https://img.shields.io/travis/{{git.user}}/{{git.repo}}/{{branch}}.svg", "url": "https://travis-ci.org/{{git.user}}/{{git.repo}}#{{branch}}" }, "coveralls": { "name": "coverage status", "img": "https://coveralls.io/repos/{{git.user}}/{{git.repo}}/badge.svg", "url": "https://coveralls.io/github/{{git.user}}/{{git.repo}}" }, "dependencies": { "name": "dependency status", "img": "https://david-dm.org/{{git.user}}/{{git.repo}}.svg?theme=shields.io", "url": "https://david-dm.org/{{git.user}}/{{git.repo}}" }, "devDependencies": { "name": "devDependency status", "img": "https://david-dm.org/{{git.user}}/{{git.repo}}/dev-status.svg", "url": "https://david-dm.org/{{git.user}}/{{git.repo}}#info=devDependencies" }, "gitter": { "name": "Gitter", "img": "https://badges.gitter.im/{{git.user}}/{{git.repo}}.svg", "url": "https://gitter.im/{{git.user}}/{{git.repo}}" }, "circleci": { "name": "CircleCI", "img": "https://img.shields.io/circleci/project/github/{{git.user}}/{{git.repo}}/{{branch}}.svg", "url": "https://circleci.com/gh/{{git.user}}/{{git.repo}}" }, "minzipped": { "name": "minzipped size", "img": "https://img.shields.io/bundlephobia/minzip/{{name}}.svg", "url": "https://bundlephobia.com/result?p={{name}}" }, "npm-downloads": { "name": "downloads", "img": "https://img.shields.io/npm/dw/{{name}}.svg", "url": "https://npmjs.org/package/{{name}}" }, "open-issues": { "name": "open issues", "img": "https://img.shields.io/github/issues-raw/{{git.user}}/{{git.repo}}.svg", "url": "https://github.com/{{git.user}}/{{git.repo}}/issues" }, "license": { "name": "license", "img": "https://img.shields.io/github/license/{{git.user}}/{{git.repo}}.svg", "url": "https://github.com/{{git.user}}/{{git.repo}}/blob/master/LICENSE" }, "semantic-release": { "name": "semantic release", "img": "https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg", "url": "https://github.com/semantic-release/semantic-release#badge" }, "greenkeeper": { "name": "Greenkeeper", "img": "https://badges.greenkeeper.io/{{git.user}}/{{git.repo}}.svg", "url": "https://greenkeeper.io/" }, "debug": { "name": "debug", "img": "https://img.shields.io/badge/debug-blue.svg", "url": "https://github.com/visionmedia/debug#readme" } }