Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.74 KB

.verb.md

File metadata and controls

50 lines (33 loc) · 1.74 KB
toc

What is "Update"?

Update is a new, open-source developer framework for automating updates of any kind to code projects. For more information:

Install

Install update

If you haven't already installed [update][] globally, you can do that now with the following command:

$ npm i -g update

Install updater-example

Then install this module:

$ npm i -g update-example

Usage

Add a file named example.txt to the current working directory, then run the updater with the following command:

$ update example

What will happen?

This updater will only modify a file named example.txt in the current working directory. By default it just adds the string foo.

Try the following steps to get familiarized with how update works:

  • run $ update example to execute the default task, which will append the string foo to the file's contents.
  • run $ update example:foo to execute the foo task, appending the string foo to the file's contents
  • run $ update example:bar to execute the bar task, appending the string bar to the file's contents
  • run $ update example.abc to execute the default task on the abc (sub-)updater, appending the string abc:default to the file's contents
  • run $ update example.abc:xyz to execute the xyz task on the abc (sub-)updater, appending the string abc:xyz to the file's contents

See the code for more details.