add docs and removed verbose print in cli

mirego · Mar 12, 2024 · cf98458 · cf98458
1 parent c1cc7c6
commit cf98458
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -58,6 +58,7 @@ $ mix deps.audit
 | `--format`               | String | `"human"`           | The format of the report to generate (`"json"` or `"human"`) |
 | `--ignore-advisory-ids`  | String | `""`                | Comma-separated list of advisory IDs to ignore               |
 | `--ignore-package-names` | String | `""`                | Comma-separated list of package names to ignore              |
+| `--ignore-file`          | String | `.mix-audit-skips`  | Path of the ignore file                                      |
 
 ## Example
 

diff --git a/lib/mix_audit/cli/help.ex b/lib/mix_audit/cli/help.ex
@@ -9,7 +9,7 @@ defmodule MixAudit.CLI.Help do
     IO.puts("--format                The format of the report to generate (human, json)")
     IO.puts("--ignore-advisory-ids   A comma-separated list of advisory IDs to ignore")
     IO.puts("--ignore-package-names  A comma-separated list of package names to ignore")
-    IO.puts("--ignore-file           Path of the ignore file (default .mix-audit-skips)")
+    IO.puts("--ignore-file           Path of the ignore file")
     IO.puts("")
     System.halt(0)
   end