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