From a90c7e8b6296fadf0cac5a7972f6c64abc504e7a Mon Sep 17 00:00:00 2001 From: Cordell Blakkan Date: Thu, 2 Jan 2025 14:08:37 -0500 Subject: [PATCH] Update README with new --help output, prepare for 6.0.0 release --- README.md | 11 ++++++----- yamale/VERSION | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4ebdbdb..5898905 100644 --- a/README.md +++ b/README.md @@ -54,25 +54,26 @@ looking up the directory tree until it finds one. If Yamale can not find a schem Usage: -```bash +``` usage: yamale [-h] [-s SCHEMA] [-e PATTERN] [-p PARSER] [-n CPU_NUM] [-x] [-v] [-V] [PATH ...] Validate yaml files. positional arguments: - PATH paths to validate, either directories or files. Default is the current directory. + PATH Paths to validate, either directories or files. Default is the current directory. options: -h, --help show this help message and exit -s SCHEMA, --schema SCHEMA filename of schema. Default is schema.yaml. -e PATTERN, --exclude PATTERN - Python regex used to exclude files from validation. Any substring match of a files absolute path will be excluded. Uses deafult Python3 regex. Option can be supplied multiple times. + Python regex used to exclude files from validation. Any substring match of a file's absolute path will be excluded. Uses + default Python3 regex. Option can be supplied multiple times. -p PARSER, --parser PARSER YAML library to load files. Choices are "ruamel" or "pyyaml" (default). -n CPU_NUM, --cpu-num CPU_NUM - number of child processes to spawn for validation. Default is 4. 'auto' to use CPU count. - -x, --no-strict disable strict mode, unexpected elements in the data will be accepted. + Number of child processes to spawn for validation. Default is 4. 'auto' to use CPU count. + -x, --no-strict Disable strict mode, unexpected elements in the data will be accepted. -v, --verbose show verbose information -V, --version show program's version number and exit ``` diff --git a/yamale/VERSION b/yamale/VERSION index 03f488b..09b254e 100644 --- a/yamale/VERSION +++ b/yamale/VERSION @@ -1 +1 @@ -5.3.0 +6.0.0