Skip to content

Commit

Permalink
Update api docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tmpfs committed Mar 19, 2016
1 parent a01a797 commit e4c8176
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,45 @@ task()

Adds task function(s) to the list of known tasks.

### Runner

```javascript
new Runner(opts)
```

Execute task functions.

* `opts` Object processing options.

#### Options

* `list` Array of tasks.
* `scope` Object task execution scope.

### get

```javascript
get(id)
```

Get a task by name identifier.

Returns a task or undefined.

* `id` Function|String task identifier.

### get

```javascript
get(id)
```

Execute a task by name identifier.

Returns a task or undefined.

* `id` Function|String task identifier.

## License

MIT
Expand Down
2 changes: 1 addition & 1 deletion doc/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Runs named task functions that return streams.

<? @include {=readme} install.md ?>

<? @exec mkapi index.js --title=API --level=2 ?>
<? @exec mkapi *.js --title=API --level=2 ?>
<? @include {=readme} license.md links.md ?>

0 comments on commit e4c8176

Please sign in to comment.