Skip to content

Commit

Permalink
Add HTML report stuff to the README [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
MathieuBuisson committed Jul 17, 2017
1 parent 543ec4f commit cf36a97
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ It can allow you to ensure that your code is compliant with metrics goals (quali

These features can be leveraged from within your PowerShell release pipeline.

PSCodeHealth can also generate a highly visual HTML report so that you can interpret the results at a glance, and easily share them :
![HTML report - Summary section](https://raw.githubusercontent.com/MathieuBuisson/PSCodeHealth/master/Examples/SummarySectionScreenshot.png "HTML report - Summary section")

Want to know more ? Head to the full documentation :
<http://pscodehealth.readthedocs.io/en/latest/>
## Requirements
Expand Down Expand Up @@ -90,6 +93,15 @@ Get-CoveragePercentage 16 2 False 100 %
```

To output the PSCodeHealth report as an HTML file, use `HtmlReportPath` parameter to specify the full path of the HTML file :

```powershell
C:\> Invoke-PSCodeHealth -Path '.\coveralls' -TestsPath '.\coveralls' -HtmlReportPath "$env:USERPROFILE\Desktop\Report.html"
```

The above command will not output anything to the PowerShell pipeline, unless you add the `PassThru` parameter.

## Contributing to PSCodeHealth

You are welcome to contribute to this project. There are many ways you can contribute :
Expand Down

0 comments on commit cf36a97

Please sign in to comment.