Skip to content
This repository has been archived by the owner on Oct 19, 2022. It is now read-only.

Commit

Permalink
README: adding info about --help option
Browse files Browse the repository at this point in the history
  • Loading branch information
Pawel Galazka committed May 6, 2017
1 parent e9b40a6 commit 4bbae54
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,15 @@ object spread operator as with `common` tasks in the example above.

## Documenting tasks

To display all available tasks from your `runfile.js` type `run` in your command line
To display all available tasks for your `runfile.js` type `run` in your command line
without any arguments:

$ run
Requiring babel-register...
Processing runfile...

Available tasks:

echo
testapi

Expand All @@ -322,7 +323,7 @@ Add `help` property to your task to get additional description:
```javascript
import { run } from 'runjs'

export function buildjs () {
export function buildjs (arg1, arg2) {

}

Expand All @@ -332,8 +333,20 @@ buildjs.help = 'Compile JavaScript files'
$ run
Requiring babel-register...
Processing runfile...

Available tasks:

buildjs
buildjs [arg1 arg2]
Compile JavaScript files

When running task with `--help` option, only help for that task will be displayed:

$ run buildjs --help
Requiring babel-register...
Processing runfile...

ARGUMENTS
[arg1 arg2]

DESCRIPTION
Compile JavaScript files

0 comments on commit 4bbae54

Please sign in to comment.