| 1 |
|
| 2 |
|
| 3 | # mrm-task-license
|
| 4 |
|
| 5 | [Mrm](https://github.com/sapegin/mrm) task that adds license file based on `license` field in `package.json`.
|
| 6 |
|
| 7 | ## What it does
|
| 8 |
|
| 9 | - Creates a license file.
|
| 10 |
|
| 11 | ## Usage
|
| 12 |
|
| 13 | ```
|
| 14 | npm install -g mrm mrm-task-license
|
| 15 | mrm license
|
| 16 | ```
|
| 17 |
|
| 18 | ## Options
|
| 19 |
|
| 20 | See [Mrm docs](../../docs/Getting_started.md) for more details.
|
| 21 |
|
| 22 | ### `license` (default: taken from `package.json`, if not found `MIT` is used)
|
| 23 |
|
| 24 | License name (like `MIT`, `Unlicense`). For full list of supported values see: [`/templates`](https://github.com/sapegin/mrm/tree/master/packages/mrm-task-license/templates).
|
| 25 |
|
| 26 | ### `licenseFile` (default: `License.md`)
|
| 27 |
|
| 28 | File name. 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).
|
| 29 |
|
| 30 | ### `name` (default: will try to read from your npm or Git config)
|
| 31 |
|
| 32 | Your name.
|
| 33 |
|
| 34 | ### `email` (default: will try to read from your npm or Git config)
|
| 35 |
|
| 36 | Your email.
|
| 37 |
|
| 38 | ## Changelog
|
| 39 |
|
| 40 | The changelog can be found in [CHANGELOG.md](CHANGELOG.md).
|
| 41 |
|
| 42 | ## Contributing
|
| 43 |
|
| 44 | Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](../../Contributing.md).
|
| 45 |
|
| 46 | ## Authors and license
|
| 47 |
|
| 48 | [Artem Sapegin](https://sapegin.me) and [contributors](https://github.com/sapegin/mrm/graphs/contributors).
|
| 49 |
|
| 50 | MIT License, see the included [License.md](License.md) file.
|