Skip to content

Commit

Permalink
generate readme documentation with verb
Browse files Browse the repository at this point in the history
  • Loading branch information
doowb committed Jul 4, 2016
1 parent 9d2d721 commit dfd8a26
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ 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:one` to the file's contents
* [ ] run `$ update example.abc:one` to execute the `one` task on the `abc` (sub-)updater, appending the string `abc:one` 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](updatefile.js) for more details.

Expand All @@ -55,7 +55,7 @@ See [the code](updatefile.js) for more details.
You might also be interested in these projects:

* [generate](https://www.npmjs.com/package/generate): The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind of required file or document from any given templates or source materials.")
* [update](https://www.npmjs.com/package/update): Update is a developer framework and CLI for automating updates of any kind in code[more](https://github.com/update/update) | [homepage](https://github.com/update/update "Update is a developer framework and CLI for automating updates of any kind in code projects. All updating is accomplished using plugins called _updaters_, which are run by command line or API, and can be installed globally, locally, or in a local `updatef")
* [update](https://www.npmjs.com/package/update): Easily keep anything in your project up-to-date by installing the updaters you want to use[more](https://github.com/update/update) | [homepage](https://github.com/update/update "Easily keep anything in your project up-to-date by installing the updaters you want to use and running `update` in the command line! Update the copyright date, licence type, ensure that a project uses your latest eslint or jshint configuration, remove dep")
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")

## Contributing
Expand Down Expand Up @@ -84,4 +84,4 @@ Released under the [MIT license](https://github.com/update/updater-example/blob/

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 01, 2016._
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 04, 2016._

0 comments on commit dfd8a26

Please sign in to comment.