mrm-task-readme

Mrm task that adds a readme file

MIT 56 个版本
mrm mrm-task readme
主页
仓库
提交 Issue
安装
npm install mrm-task-readme
yarn add mrm-task-readme
pnpm add mrm-task-readme
bun add mrm-task-readme
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.

packageName (default: name field in package.json)

Package name.

name (default: will try to read from your package.json, 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.

license (default: taken from package.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.

licenseFile (default: "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).

contributingFile (default: "Contributing.md")

Name of the Contributing file.

includeContributing (default: true)

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.

版本列表
4.1.22 2023-09-14
4.1.21 2023-09-13
4.1.20 2023-09-13
4.1.19 2023-09-13
4.1.18 2023-09-13
4.1.17 2023-07-04
4.1.16 2023-07-04
4.1.15 2023-07-04
4.1.14 2023-03-10
4.1.13 2022-10-19
4.1.12 2022-10-19
4.1.11 2022-10-19
4.1.10 2022-10-18
4.1.9 2022-10-18
4.1.8 2022-10-17
4.1.7 2022-10-16
4.1.6 2022-09-15
4.1.5 2022-09-15
4.1.4 2022-09-15
4.1.3 2022-09-15
4.1.2 2022-09-15
4.1.1 2022-09-15
4.1.0 2022-08-23
4.0.0 2022-03-22
3.0.8 2021-10-14
3.0.7 2021-09-18
3.0.6 2021-08-03
3.0.5 2021-08-03
3.0.4 2021-08-02
3.0.3 2021-07-21
3.0.2 2021-07-21
3.0.0 2021-04-07
2.4.1 2021-04-01
2.4.0 2021-02-25
2.3.0 2021-02-09
2.2.0 2021-02-09
2.1.3 2021-02-08
2.1.2 2021-02-03
2.1.1 2020-11-04
2.1.0 2020-10-28
2.0.10 2020-10-27
2.0.9 2020-10-27
2.0.8 2020-10-27
2.0.7 2020-10-26
2.0.6 2020-08-19
2.0.5 2020-06-08
2.0.4 2020-04-07
2.0.3 2020-03-20
2.0.2 2020-01-27
2.0.1 2020-01-25
2.0.0 2019-11-24
1.1.3 2018-09-01
1.1.2 2018-02-23
1.1.1 2017-12-27
1.1.0 2017-09-20
1.0.0 2017-09-05