Skip to content

Commit

Permalink
Fixed typo in README.md (#34)
Browse files Browse the repository at this point in the history
* Fixed typo on README.md
  • Loading branch information
equelin authored Jun 20, 2017
1 parent 5498c16 commit 5f82c91
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,34 @@

# Format-Pester

Powershell module for documenting Pester's results.
Powershell module for documenting Pester's results.

All the formating work is done by the module [PScribo](https://github.com/iainbrighton/PScribo).
All the formatting work is done by the module [PScribo](https://github.com/iainbrighton/PScribo).

Reports are generated base on a custom PowerShell object returned by Invoke-Pester run with the parameter `PassThru`. NUnit style files generated by Pester are not supported at that moment by Format-Pester.
Reports are generated based on a custom PowerShell object returned by Invoke-Pester. You have to provide the parameter `PassThru` to Pester. Currently, NUnit style files generated by Pester are not supported.

If you can't generate report on a computer where tests are executed please save tests results piping them to `Export-Clixml`.

You can be interested also in the [ReportUnit](https://github.com/reportunit/reportunit) tool what is a report generator for the test-runner family. It uses stock reports from NUnit, MsTest, xUnit, TestNG and Gallio and converts them HTML reports with dashboards.
You can be interested also in the [ReportUnit](https://github.com/reportunit/reportunit) tool. It's a report generator for the test-runner family. It uses stock reports from NUnit, MsTest, xUnit, TestNG and Gallio and converts them into HTML reports with dashboards.

## Report example

![](./img/Format-Pester-1.5.0-part.png)

Partial screenshot for a HTML report generated by Format-Pester v. 1.5.0, PScribo v. 0.7.15.63, [the full screenshot](./img/Format-Pester-1.5.0-full.png).

More examples you can find [here](/examples/).
You can find more examples [here](/examples/).

## Supported languages

Since version 1.3.0 internationalization of generated reports is supported. Internalization means that report parts e.g. section names, columns headers, etc. can be wrote in a language different than English.
Since version 1.3.0 internationalization of generated reports is supported. It means that reports parts e.g. section names, columns headers, etc. can be wrote in a different language than English.

Currently available languages
Currently available languages are:

- en-US - English United Staes - main language
- en-US - English United States - main language
- pl-PL - Polish

If would you like add support for your language please read the section [Information for translators](https://github.com/equelin/Format-Pester/wiki/Information-for-translators) in the project wiki.
If you would like to add support for your language please read the section [Information for translators](https://github.com/equelin/Format-Pester/wiki/Information-for-translators) in the project's wiki.

# Requirements

Expand All @@ -39,15 +39,15 @@ If would you like add support for your language please read the section [Informa

# Usage

Format-Pester is the PowerShell module so before usage it you need import it - more instruction you can find in [wiki](https://github.com/equelin/Format-Pester/wiki/Importing-Format-Pester).
Format-Pester is a PowerShell module so it has to be imported before using it - you can find more instructions in the [wiki](https://github.com/equelin/Format-Pester/wiki/Importing-Format-Pester).

## Example 1

```PowerShell
Invoke-Pester -PassThru | Format-Pester -Path . -Format HTML,Word,Text
```

This command will document the results of the Pester's tests. Documents will be store in the current path and they will be available in 3 formats (.html,.docx and .txt).
This command will document the results of the Pester's tests. Documents will be stored in the current path and they will be available in 3 formats (.html,.docx and .txt).

## Example

Expand All @@ -57,9 +57,9 @@ This command will document the results of the Pester's tests. Documents will be
Import-Clixml -Path .\Test-Result.xml | Format-Pester -Format .\ -BaseFileName Test-Result -Format HTML -FailedOnly
```

The first command you can run e.g. on a server where PScribo and Format-Pester is not installed. The tests results will be stored in a file as xml representation of object.
You can run the first command on a server where PScribo and Format-Pester are not installed. The tests results object will be stored in a xmf file.

After copy the file to the computer where PScribo and Format-Pester are available you can generate report. The html file will be generated with results of failed tests only.
After copying the file to the computer where PScribo and Format-Pester are available you can generate a report. In this example, the HTML file will be generated with results of failed tests only.

## Online help

Expand All @@ -80,5 +80,5 @@ You can read [online version of help](/doc/Format-Pester.md) - online help gener
# [TODO and development plans](TODO.md)

# License
Copyright 2016 Erwan Quelin and the community.
Copyright 2016-17 Erwan Quelin and the community.
Licensed under [the MIT License](LICENSE)

0 comments on commit 5f82c91

Please sign in to comment.