From 72b95adb08b6d7cebaa23c34a4a654a0e08e33cd Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Wed, 5 Aug 2020 15:30:05 +0200 Subject: [PATCH] Documentation fixes --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e0f5d4..d86e912 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,19 @@ When running `scriptless-svg` on the [Web Platform Tests for SVG](https://github Additionally, you can pass the `--errors-only` flag to omit all files from the output that passed the check successfully. This is especially recommended for CI setups where you are only interested in the failures. +Note that __by default__, only files that end in `.svg` are considered when you specify a directory path. If you wish to also scan files with a different extension, it must be an explicit glob. + The process will return exit code 1 if any scanned files failed the check (ie. contain scripts), or exit code 0 if all files passed. ## Examples -Scan all `*.svg* files in the current directory and any subdirectories: +Scan all `*.svg` files in the current directory and any subdirectories: ```sh scriptless-svg ``` -Scan all `*.svg* files in a given target directory and its subdirectories: +Scan all `*.svg` files in a given target directory and its subdirectories: ```sh scriptless-svg /path/to/directory