Documentation fixes

master
Sven Slootweg 4 years ago
parent 93f8757032
commit 72b95adb08

@ -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. 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. 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 ## Examples
Scan all `*.svg* files in the current directory and any subdirectories: Scan all `*.svg` files in the current directory and any subdirectories:
```sh ```sh
scriptless-svg 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 ```sh
scriptless-svg /path/to/directory scriptless-svg /path/to/directory

Loading…
Cancel
Save