From 8870c915d18bfb66bdf92c690104b770cafa0d9d Mon Sep 17 00:00:00 2001 From: Pedro de Oliveira Date: Sun, 7 May 2023 23:32:14 +0100 Subject: [PATCH] Document the `--wildcard` argument. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e10488..d877977 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The `--path` argument specifies the path to the directory where the files to be The `--pattern` argument specifies the regular expression pattern to match against the filenames. This argument is required. -You can use matching groups in the pattern to capture parts of the filename that you want to use in the replacement pattern. For example, the pattern `"S(\d+)E(\d+)"` will match on `"S01E23"` and capture `"01"` in group `1` and `"23"` in group `2`. +You can use matching groups in the pattern to capture parts of the filename that you want to use in the replacement pattern. For example, the pattern `"S(\d+)E(\d+)"` will match on `"S01E23"` and capture `"01"` in group 1 and `"23"` in group 2. ### `--replacement` @@ -38,6 +38,12 @@ You can also use the following special tags in the replacement pattern: * `{name}` - filename without extension * `{ext}` - extension +### `--wildcard` (optional) + +Specifies a wildcard pattern to filter which files in the directory are considered. Only files whose names match the wildcard will be renamed. The default value is `"*"`. + +For example, if you want to only rename files with the `.mkv` extension, you can use the wildcard pattern `"*.mkv"`. + Here is an example usage: ```shell