README
mrm-task-readme
Mrm task that adds a Readme file.
What it does
- Creates a Readme file
Usage
npx mrm readme
Options
See Mrm docs for more details.
(default: packageNamename
field in package.json
)
Package name.
(default: will try to read from your namepackage.json
, npm or Git config)
Your name.
(default: will try to read from your npm or Git config) url
Your site URL.
(default: readmeFile"Readme.md"
)
Name of the Readme file.
(default: taken from licensepackage.json
, if not found "MIT"
is used)
License name (like MIT
, Unlicense
). For full list of supported values see: /templates
.
This is only needed if licenseFile
is used.
(default: licenseFile"License.md"
)
Name of the license file. May use ${license}
within the string to insert the value of license
dynamically into the name (to maintain this general template independently from the license type, while non-redundant with it).
(default: contributingFile"Contributing.md"
)
Name of the Contributing file.
(default: includeContributingtrue
)
Whether to include the Contributing section.
Changelog
The changelog can be found in CHANGELOG.md.
Contributing
Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.
Authors and license
Artem Sapegin and contributors.
MIT License, see the included License.md file.