@mxttwoods/readme-generator v1.3.0

@mxttwoods/readme-generator

Documentation

A CLI that generates README.md files
@mxttwoods/readme-generator will suggest you default answers by reading your package.json and git configuration.

Example of package.json with good meta data:

// a package.json is not required to run npx @mxttwoods/readme-generator

{
    "name": "@mxttwoods/readme-generator",
    "version": "1.0.0",
    "description": "CLI that generates beautiful README.md files.",
    "author": "Matthew Woods",
    "license": "MIT",
    "homepage": "https://github.com/mxttwoods/readme-generator#readme",
    "repository": {
        "type": "git",
        "url": "git+https://github.com/mxttwoods/readme-generator.git"
    },
    "bugs": {
        "url": "https://github.com/mxttwoods/readme-generator/issues"
    },
    "engines": {
        "npm": ">=5.5.0",
        "node": ">=9.3.0"
    }
}

Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

Just run the following command at the root of your project and answer questions:

npx @mxttwoods/readme-generator

Or use default values for all questions (-y):

npx @mxttwoods/readme-generator -y

Use your own ejs README template (-p):

npx @mxttwoods/readme-generator -p path/to/my/own/template.md

License

This project is MIT licensed.