From 86e553361f2f8940bc51fd92bd8608e8cfbf3628 Mon Sep 17 00:00:00 2001
From: Andy Pfister <andy.pfister@hey.com>
Date: Mon, 9 Dec 2024 16:57:22 +0100
Subject: [PATCH] Clarify format for `components` parameter

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9e42e50..02608d7 100644
--- a/README.md
+++ b/README.md
@@ -8,11 +8,39 @@ On Windows, we install an Express edition of the container. On Linux, a Docker c
 
 ### Inputs
 
-* `components`: Specify the components you want to install. Can be `sqlengine` and `sqlcmd`.
+* `components`: Specify the components you want to install. Can be `sqlengine` and `sqlcmd`. The list of components needs be a comma-separated list like `sqlengine,sqlcmd`. [GitHub Actions does not support passing YAML lists to composite actions](https://github.com/actions/runner/issues/2238).
 * `force-encryption`: When you request to install `sqlengine`, you can set this input to `true` in order to encrypt all connections to the SQL server. The action will generate a self-signed certificate for that. Default is `false`.
 * `sa-password`: The sa password for the SQL instances. Default is `bHuZH81%cGC6`.
 * `version`: Version of the SQL server you want to install (2017, 2020 or 2022).
 
+### Example
+
+```yaml
+name: Continuous Integration
+
+on:
+  pull_request:
+  push:
+  schedule:
+    - cron: "30 8 * * 1"
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup MSSQL
+        uses: andyundso/setup-mssql@v1
+        with:
+          components: sqlcmd,sqlengine
+          force-encryption: true
+          sa-password: "iamastrongpassword1234!"
+          version: 2022
+```
+
 ## License
 
 The scripts and documentation in this project are released under the MIT License.