Skip to content

Commit

Permalink
Update README.md (#268)
Browse files Browse the repository at this point in the history
* Fix report formatting

* Update report preview image

* Add example of PDF report

* Update README.md
  • Loading branch information
svkirillov authored Feb 12, 2025
1 parent 9088260 commit 68f2433
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ Summary:

The report file `waf-evaluation-report-<date>.pdf` is available in the `reports` folder of the user directory. You can also specify the directory to save the reports with the `reportPath` parameter and the name of the report file with the `reportName` parameter. To learn advanced configuration options, please use this [link](#configuration-options).

You can found an example of PDF report [here](./docs/report_example.pdf).

![Example of GoTestWaf report](./docs/report_preview.png)

## Demos
Expand Down
Binary file added docs/report_example.pdf
Binary file not shown.
Binary file modified docs/report_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions pkg/report/report_template.html
Original file line number Diff line number Diff line change
Expand Up @@ -387,11 +387,11 @@ <h4 class="grade__title">Overall grade:</h4>
<br>
<span class="row__name">GoTestWAF version</span>
:
<span class="row__content">{{.GtwVersion}}</span>
<span class="row__content mono">{{.GtwVersion}}</span>
<br>
<span class="row__name">Test cases fingerprint</span>
:
<span class="row__content">{{.TestCasesFP}}</span>
<span class="row__content mono">{{.TestCasesFP}}</span>
<br>
{{$length := len $.OpenApiFile}}{{if ne $length 0}}
<span class="row__name">OpenAPI file</span>
Expand Down

0 comments on commit 68f2433

Please sign in to comment.