Skip to content
This repository has been archived by the owner on Mar 26, 2020. It is now read-only.

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Jan 28, 2015
1 parent 17a4afd commit fb1078a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions readme.md
Expand Up @@ -16,9 +16,9 @@ npm test
> Async execute command via spawn. All arguments are rebuilt, merged, structured, normalized
and after all passed to [cross-spawn][cross-spawn], which actually is Node's `spawn`.

* `<cmd>` **{String}**
* `[args]` **{Array}**
* `[opts]` **{Object}**
* `<cmd>` **{String}** Command/program to execute. You can pass subcommands, flags and arguments separated with space
* `[args]` **{Array}** command/program arguments that will be merged with given in `cmd`
* `[opts]` **{Object}** pass options to [spawn][cross-spawn] and [github-short-url-regex][github-short-url-regex]
* `<callback>` **{Function}**
* `returns` **{Stream}** actually what `child_process.spawn` returns

Expand Down Expand Up @@ -160,4 +160,5 @@ Released under the [`MIT`][license-url] license.

_Powered and automated by [kdf](https://github.com/tunnckoCore), January 28, 2015_

[cross-spawn]: https://github.com/IndigoUnited/node-cross-spawn
[cross-spawn]: https://github.com/IndigoUnited/node-cross-spawn
[github-short-url-regex]: https://github.com/regexps/github-short-url-regex

0 comments on commit fb1078a

Please sign in to comment.