Merge pull request #28 from lxxxvi/add-documentation-for-silent-option

add documentation about --silent option
lxxxvi · Jun 9, 2023 · b7355ef · b7355ef
2 parents 1e91a13 + 4590229
commit b7355ef
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -80,14 +80,15 @@ gem install ruboclean
 ## Command synopsis
 
 ```shell
-ruboclean [path] [--preserve-comments]
+ruboclean [path] [--silent] [--preserve-comments]
 ```
 
 ### Parameters
 
 | Parameter | Description |
 |:-|:-|
 | `path` | Can be a directory that contains a `.rubocop.yml`, or a path to a `.rubocop.yml` directly. Defaults to the current working directory.  |
+| `--silent` | Suppress any output displayed on the screen when executing the command. |
 | `--preserve-comments` |  Preserves **preceding** comments for each top-level entry in the configuration. Inline comments are **not** preserved. |
 
 ### Examples