From ca8ba535962d19398a351261288806b2f7ce1f29 Mon Sep 17 00:00:00 2001
From: James Garbutt <43081j@users.noreply.github.com>
Date: Sat, 15 Jun 2024 09:42:44 +0100
Subject: [PATCH] docs: add args to readme (#8)

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index fa7543e..169fa7e 100644
--- 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: