mrm-task-readme

Mrm task that adds a Readme file.

What it does

  • Creates a Readme file

Usage

npm install -g mrm mrm-task-readme
mrm readme

Options

See Mrm docs for more details.

github (default: extracted from .git/config file)

Your GitHub user name.

name (default: will try to read from your npm or Git config)

Your name.

url (default: will try to read from your npm or Git config)

Your site URL.

readmeFile (default: Readme.md)

Name of the Readme file.

licenseFile (default: License.md)

Name of the license file.

packageName (default: name field in package.json)

Package name.