Update the copyright statement and year in a MIT
- What is "Update"?
- What does updater-license do?
- Getting started
What is "Update"?
Update is a new, open-source developer framework for automating updates of any kind to code projects. All actual updating is done plugins called "updaters", like this one.
For more information:
What does updater-license do?
Most updaters do one specific thing. This updater add a
LICENSE file or replaces the
LICENSE file in the current working directory using a template defined by you in
~/templates/LICENSE (user home on your system), or the generic template in this project's templates directory.
Note that currently this updater only handles MIT licenses, but we'd love a pr to add support for other licenses.
Installing the CLI
updater-license from the command line, you'll need to install Update globally first. You can do that now with the following command:
$ npm install --global update
This adds the
update command to your system path, allowing it to be run from any directory.
Install this module with the following command:
$ npm install --global updater-license
Make sure your work is committed, then run the updater's
default task with the following command:
$ update license
What will happen?
$ update license command, this updater's
default task will be executed, which replaces the
LICENSE file in the cwd with the
~/templates/LICENSE template defined by you, or the default templates found in templates/mit.tmpl in this repository.
Visit the documentation for tasks.
You might also find these projects useful.
- updater-editorconfig: Update or add a
.editorconfigin the current working directory using a template defined by… more | homepage
- updater-eslint: Update a
.eslintrc.jsonfile based on a template and preferences. This updater can be used… more | homepage
- updater-license: Update the copyright statement and year in a MIT
LICENSEfile. | homepage
Here are some suggestions!
- If you get like Update and want to tweet about it, please use the hashtag
- Show your love by starring Update and
- Get implementation help on StackOverflow (please use the
updatejstag in questions)
- Gitter Discuss Update with us on Gitter
- If you publish an updater, thank you! To make your project as discoverable as possible, please add the keyword
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
This file was generated by verb-generate-readme, v0.6.0, on June 26, 2017.