From cafa40d6ec5934ee2d38e93acba8028096c15403 Mon Sep 17 00:00:00 2001
From: tommie <tommie@users.noreply.github.com>
Date: Wed, 26 Jun 2024 11:18:49 +0200
Subject: [PATCH] Adds examples of input arrays.

Having to wrap it all as a string is a bit strange, and an example helps.

I don't actually think the `JSON.parse` is needed, because the YAML flow sequence syntax handles that case too: https://yaml.org/spec/1.2.2/#741-flow-sequences
---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 272eb9c3..f6eef55a 100644
--- a/README.md
+++ b/README.md
@@ -255,6 +255,29 @@ You can also use the `committer_name` and `committer_email` inputs to make it ap
     committer_email: 41898282+github-actions[bot]@users.noreply.github.com
 ```
 
+### Array inputs
+
+Due to limitations in the GitHub action APIs, all inputs must be either strings or booleans.
+The action supports arrays in `add` and `remove`, but they have to be encoded as a string with a YAML flow sequence:
+
+```yaml
+- uses: EndBug/add-and-commit@v9
+  with:
+    add: '["afile.txt", "anotherfile.txt"]'
+```
+
+(note the single-quotes) or a YAML block sequence:
+
+```yaml
+- uses: EndBug/add-and-commit@v9
+  with:
+    add: |
+      - afile.txt
+      - anotherfile.txt
+```
+
+(Note the pipe character making it a multiline string.)
+
 ### Automated linting
 
 Do you want to lint your JavaScript files, located in the `src` folder, with ESLint, so that fixable changes are done without your intervention? You can use a workflow like this: