Nonchalantly Performs Magic

    updater-example

    0.1.2 • Public • Published

    updater-example NPM version NPM downloads

    This is an example updater for the update library, to provide a basic demonstration of how updaters work.

    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.

    Related projects

    You might also be interested in these projects:

    • generate: The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind… more | homepage
    • update: Easily keep anything in your project up-to-date by installing the updaters you want to use… more | homepage
    • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Running tests

    Install dev dependencies:

    $ npm install -d && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2016, Jon Schlinkert. Released under the MIT license.


    This file was generated by verb, v0.9.0, on July 04, 2016.

    Install

    npm i updater-example

    DownloadsWeekly Downloads

    5

    Version

    0.1.2

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar