docs: add args to readme (#8)

tinylibs · Jun 15, 2024 · ca8ba53 · ca8ba53
1 parent 5e25114
commit ca8ba53
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -132,6 +132,12 @@ x('ls', ['-l'])
   .pipe('grep', ['js']);
 ```
 
+The parameters are as follows:
+
+- `command` - the command to execute (_without any arguments_)
+- `args` - an array of arguments
+- `options` - options object
+
 ### `process`
 
 The underlying node `ChildProcess`. For example: