From d7492352fdf084086c93cf780b742e40d7ed7fa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Alet?= Date: Thu, 7 Apr 2022 10:57:40 +1100 Subject: [PATCH] doc. Improved documentation. Closes #74. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 423b948..e0d3ab0 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,18 @@ strict mode before, else `-1`. For convenience, all or parts of the command line arguments can be read from a file, one per line, by using the well known `@argsfile` -syntax. +syntax. For example you could do something like this : + +```shell +$ find . -type f -name "*.yml" >list-of-yaml-files +$ yamlfixer --nochange --summary @list-of-yaml-files +``` + +Although this could probably be shortened to : + +```shell +$ yamlfixer --nochange --summary --recurse -1 . +``` **IMPORTANT:** Not all problems are fixable by `yamlfixer`. Due to the fact that `yamllint` doesn't currently report all faulty lines,