Skip to content

Commit ca8ba53

Browse files
authored
docs: add args to readme (#8)
1 parent 5e25114 commit ca8ba53

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,12 @@ x('ls', ['-l'])
132132
.pipe('grep', ['js']);
133133
```
134134

135+
The parameters are as follows:
136+
137+
- `command` - the command to execute (_without any arguments_)
138+
- `args` - an array of arguments
139+
- `options` - options object
140+
135141
### `process`
136142

137143
The underlying node `ChildProcess`. For example:

0 commit comments

Comments
 (0)