mrm-task-readme
Mrm task that adds a readme file
Last updated a month ago by sapegin .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install mrm-task-readme 
SYNC missed versions from official npm registry.

mrm-task-readme

Mrm task that adds a Readme file.

What it does

  • Creates a Readme file

Usage

npm install -g mrm mrm-task-readme
mrm readme

Options

See Mrm docs for more details.

github (default: extracted from .git/config file)

Your GitHub user name.

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

licenseFile (default: License.md)

Name of the license file.

packageName (default: name field in package.json)

Package name.

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.

Current Tags

  • 2.0.6                                ...           latest (a month ago)

12 Versions

  • 2.0.6                                ...           a month ago
  • 2.0.5                                ...           4 months ago
  • 2.0.4                                ...           6 months ago
  • 2.0.3                                ...           6 months ago
  • 2.0.2                                ...           8 months ago
  • 2.0.1                                ...           8 months ago
  • 2.0.0                                ...           10 months ago
  • 1.1.3                                ...           2 years ago
  • 1.1.2                                ...           3 years ago
  • 1.1.1                                ...           3 years ago
  • 1.1.0                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
Maintainers (1)
Downloads
Today 1
This Week 20
This Month 1
Last Day 5
Last Week 52
Last Month 124
Dependencies (3)
Dev Dependencies (0)
None

Copyright 2014 - 2016 © taobao.org |