Skip to content

Commit

Permalink
docs: add images
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Jun 4, 2024
1 parent 1f3ab78 commit de93e75
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

> Send Microsoft Teams message with test result from popular testing frameworks
![Example view](assets/results.png)

**If you find this project useful, consider giving it a GitHub star**

It means a lot to us and helps us grow this open source library.
Expand Down Expand Up @@ -58,12 +60,16 @@ To send the test results summary to Teams:
npx teams-ctrf results /path/to/ctrf-report.json
```

![Results view](assets/results.png)

To send flaky test report to Teams:

```sh
npx teams-ctrf flaky /path/to/ctrf-report.json
```

![Flaky view](assets/flaky.png)

### Send Only on Failures

To send the test results summary to Teams only if there are failed tests, use the `--onFailOnly` option:
Expand Down
Binary file added assets/flaky.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "teams-ctrf",
"version": "0.0.2",
"version": "0.0.3",
"description": "",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit de93e75

Please sign in to comment.