From ba1e5eec18b21d1c67d782401668257f09a37a94 Mon Sep 17 00:00:00 2001 From: Tim Lucas Date: Wed, 21 Nov 2018 23:31:38 +1100 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ad1aae2..90eac11 100644 --- a/README.md +++ b/README.md @@ -13,15 +13,21 @@ steps: files: scripts/*.sh ``` -## Options +## Configuration -### `files` +### Required -The files (or globs) to run shellcheck on +### `files` (string or array of strings) -### `options` +The files (or globs) to run shellcheck on. -Any options to pass to shellcheck +### Optional + +### `options` (string or array of strings) + +Command line options to pass to shellcheck. + +Default: `"--color=always"` ## License