From 2c455a07fdafa3ea78a5307e2dcc3aa9f0b4186e Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Tue, 13 Aug 2024 01:30:30 +0200 Subject: [PATCH] Update README after --help changes --- README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 932aaf1..7875e06 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ OPTIONS ... Input path(s) (files and/or directories) to process. For directories, all files (recursively) with the '*.jl' suffix are used as input files. - If path is `-` input is read from stdin and output written to stdout. + If no path is given, or if path is `-`, input is read from stdin. -c, --check Do not write output and exit with a non-zero code if the input is not @@ -90,23 +90,17 @@ OPTIONS -d, --diff Print the diff between the input and formatted output to stderr. - Requires `git` or `diff` to be installed. - - --fail-fast - Exit immediately after the first error. Only applicable when formatting - multiple files in the same invocation. + Requires `git` to be installed. --help Print this message. -i, --inplace - Edit files in place. This option is required when passing multiple input - paths. + Format files in place. - -o, --output - Output file to write formatted code to. If the specified file is `-` - output is written to stdout. This option can not be used together with - multiple input paths. + -o , --output= + File to write formatted output to. If no output is given, or if the file + is `-`, output is written to stdout. ``` In addition to the CLI there is also the two function `Runic.format_file` and