Merge pull request #537 from evermake/494

add available CLI options to README.md
cqfn · Feb 11, 2024 · 8c603ed · 8c603ed
2 parents 42915d9 + d4b60d6
commit 8c603ed
Showing 1 changed file with 16 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -40,16 +40,26 @@ and then:
 ```bash
 $ java -jar jpeek-jar-with-dependencies.jar --sources . --target ./jpeek
 ```
-<!--
-@todo #452:30min Improve how to use section on README.md
- How to Use section must be improved; we need to explain the many parameters
- that jpeek jar accepts and the default values for each parameter.
--->
-
 
 jPeek will analyze Java files in the current directory.
 XML reports will be generated in the `./jpeek` directory. Enjoy.
 
+<details>
+<summary>Available CLI options</summary>
+
+| Option                      | Description                                                                        |
+|-----------------------------|------------------------------------------------------------------------------------|
+| `-s, --sources <path>`      | **Required.** Path to directory with the class files                               |
+| `-t, --target <path>`       | **Required.** Path to directory where the reports will be generated                |
+| `--include-ctors`           | Include constructors into all formulas                                             |
+| `--include-static-methods`  | Include static methods into all formulas                                           |
+| `--include-private-methods` | Include private methods into all formulas                                          |
+| `--metrics <metrics>`       | Comma-separated list of metrics to include (default: `"LCOM5,NHD,MMAC,SCOM,CAMC"`) |
+| `--overwrite`               | Overwrite the target directory, if it exists, or exit with error                   |
+| `--quiet`                   | Turn off logging                                                                   |
+| `--help`                    | Display help message                                                               |
+</details>
+
 You can also deploy it as a web service to your own platform. Just compile it
 with `mvn clean package --settings settings.xml` and then run, as `Procfile` suggests.
 You will need to have `settings.xml` with the following data: