From ac6b9a8b7dd09cc52b95024bc9d10a9223a42d93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikola=20Mehe=C5=A1?= Date: Thu, 21 Mar 2024 15:54:24 +0100 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4eea33c..689b8a6 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,11 @@ treblle-cli insights path/to/openapi-spec.json You then have various options available to you. By default you will get an overview of the report, which will allow you to have a high-level overview of your API Insights score. You can also use any of the following options: -### `--technology` Technology Profile +### Technology Profile Add the `--technology` flag to see the technology profile discovered on your API. -### `--details` Details +### Details The `--details` flag requires one of the following options: @@ -66,3 +66,11 @@ The `--details` flag requires one of the following options: - `--details=quality` to show the quality test pass/fail for your API. - `--details=all` to show the performance, security, and quality test pass/fail for your API. +### Miniumum score limit + +The `--m` flag gives you a possibility to set a minimum score in CI/CD enviroments: + +- `--m 90` to limit any of test to be at least 90 to pass + + +