create-readme/package.json

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

{
  "name": "create-readme",
  "description": "Automatically creates README.md based on package.json and other existing files.",
  "bin": "bin/create-readme.js",
  "main": "lib/main.js",
  "files": [
    "bin/**/*",
    "lib/**/*",
    "data/**/*",
    "templates/**/*"
  ],
  "config": {
    "readme": {
      "addUsage": "Configuration options can also be set in package.json's config.readme.",
      "badges": [
        "npm-version",
        "npm-downloads",
        "open-issues",
        "license",
        "debug",
        "travis",
        "coveralls",
        "dependencies",
        "devDependencies",
        "greenkeeper",
        "semantic-release",
        "gitter"
      ]
    },
    "ghooks": {
      "pre-commit": "npm run test:lint",
      "commit-msg": "validate-commit-msg",
      "pre-push": "npm run test"
    }
  },
  "release": {
    "plugins": [
      "@semantic-release/commit-analyzer",
      "@semantic-release/release-notes-generator",
      "@semantic-release/changelog",
      "@semantic-release/npm",
      "@semantic-release/github"
    ]
  },
  "scripts": {
    "build": "n-clean lib && coffee -c -o lib/ src/ && npm run doc",
    "doc": "npm run doc:docs && npm run doc:readme",
    "doc:docs": "codo src -o ./docs",
    "doc:readme": "node bin/create-readme",
    "test": "npm run test:lint && npm run test:docs && npm run test:tests",
    "test:docs": "codo src --test --min-coverage 100",
    "test:lint": "coffeelint -f .coffeelint.json src examples",
    "test:tests": "test-coffee-module -c",
    "coveralls": "cat coverage/lcov.info | coveralls"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/dbartholomae/create-readme.git"
  },
  "directories": {
    "doc": "docs",
    "example": "examples"
  },
  "keywords": [
    "readme",
    "markup",
    "build"
  ],
  "author": "Daniel Bartholomae <db@wappforge.com> (http://www.wappforge.com/)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/dbartholomae/create-readme/issues"
  },
  "homepage": "https://github.com/dbartholomae/create-readme#readme",
  "dependencies": {
    "bluebird": "^3.1.1",
    "commander": "^4.0.0",
    "debug": "^4.1.0",
    "github-url-to-object": "^4.0.4",
    "mustache": "^4.0.0",
    "require-all": "^3.0.0"
  },
  "devDependencies": {
    "@lluis/codo": "^2.1.3",
    "@semantic-release/changelog": "^3.0.1",
    "coffee-script": "*",
    "coffeelint": "^2.1.0",
    "coffeelint-no-mocha-only": "^1.0.0",
    "coffeelint-variable-scope": "^0.0.4",
    "coveralls": "*",
    "ghooks": "*",
    "mock-fs": "^4.7.0",
    "nodemon": "^2.0.0",
    "npm-build-tools": "*",
    "proxyquire": "^2.1.0",
    "semantic-release": "^15.10.2",
    "test-coffee-module": "^1.0.5",
    "validate-commit-msg": "*"
  },
  "version": "2.1.3"
}