Mrm task that adds a readme file
npm install mrm-task-readmeMrm task that adds a Readme file.
- Creates a Readme file
``
npx mrm readme
See Mrm docs for more details.
Package name.
Your name.
Your site URL.
Name of the Readme file.
License name (like MIT, Unlicense). For full list of supported values see: /templates.
This is only needed if licenseFile is used.
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).
Name of the Contributing file.
Whether to include the Contributing section.
The changelog can be found in CHANGELOG.md.
Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.
Artem Sapegin and contributors.
MIT License, see the included License.md file.