Skip to content

Commit

Permalink
Update README after --help changes
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikekre committed Aug 12, 2024
1 parent 73ab2ae commit 2c455a0
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,31 +82,25 @@ OPTIONS
<path>...
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
formatted correctly.
-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 <file>
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 <file>, --output=<file>
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
Expand Down

0 comments on commit 2c455a0

Please sign in to comment.