Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nikme authored Mar 21, 2024
1 parent 086530e commit ac6b9a8
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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



0 comments on commit ac6b9a8

Please sign in to comment.