Browse Source

Update README after --help changes

pull/44/head
Fredrik Ekre 1 year ago
parent
commit
2c455a07fd
No known key found for this signature in database
GPG Key ID: DE82E6D5E364C0A2
  1. 18
      README.md

18
README.md

@ -82,7 +82,7 @@ OPTIONS
<path>... <path>...
Input path(s) (files and/or directories) to process. For directories, Input path(s) (files and/or directories) to process. For directories,
all files (recursively) with the '*.jl' suffix are used as input files. 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 -c, --check
Do not write output and exit with a non-zero code if the input is not Do not write output and exit with a non-zero code if the input is not
@ -90,23 +90,17 @@ OPTIONS
-d, --diff -d, --diff
Print the diff between the input and formatted output to stderr. Print the diff between the input and formatted output to stderr.
Requires `git` or `diff` to be installed. Requires `git` to be installed.
--fail-fast
Exit immediately after the first error. Only applicable when formatting
multiple files in the same invocation.
--help --help
Print this message. Print this message.
-i, --inplace -i, --inplace
Edit files in place. This option is required when passing multiple input Format files in place.
paths.
-o, --output <file> -o <file>, --output=<file>
Output file to write formatted code to. If the specified file is `-` File to write formatted output to. If no output is given, or if the file
output is written to stdout. This option can not be used together with is `-`, output is written to stdout.
multiple input paths.
``` ```
In addition to the CLI there is also the two function `Runic.format_file` and In addition to the CLI there is also the two function `Runic.format_file` and

Loading…
Cancel
Save