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 3, 2024
1 parent dc29ef2 commit 99ed878
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

> Send Slack 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.

## We need your help

We believe CTRF can save **a lot** of time for engineers, a single data serialisation report, well structured, community driven and works with any framework. For over 30s years software engineers have used a de facto data serialisation report, you know the one! But we feel it’s time to modernise.
We believe CTRF can save **a lot** of time for engineers, a single data serialisation report, well structured, community driven and works with any framework. For over 30 years software engineers have used a de facto data serialisation report, you know the one! But we feel it’s time to modernise.

The only way we can grow CTRF is with your help and the support of the software engineering community.

Expand All @@ -17,7 +19,7 @@ The only way we can grow CTRF is with your help and the support of the software
- Join and build with us! We are looking for [contributors](https://github.com/ctrf-io), get involved in this early stage project. All contributions are welcome.
- Give this repository a star ⭐⭐⭐⭐⭐⭐
- Follow the CTRF [GitHub organisation](https://github.com/ctrf-io)
- Clap for our medium articles (30 times each) 👏
- Clap for our [Medium articles](https://medium.com/@ma11hewthomas) (30 times each) 👏
- Share, share share! Discord, Reddit, Twitter, LinkedIn, Slack, Teams, whereever! - please share our [libraries](https://github.com/orgs/ctrf-io/repositories), our [homepage](https://www.ctrf.io/), our [Medium articles](https://medium.com/@ma11hewthomas)
- Maybe even write a blog about us!
- Try our [tools](https://github.com/orgs/ctrf-io/repositories)
Expand Down Expand Up @@ -62,12 +64,16 @@ To send the test results summary to Slack:
npx slack-ctrf results /path/to/ctrf-report.json
```

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

To send flaky test report to Slack:

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

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

### Send Only on Failures

To send the test results summary to Slack 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.

0 comments on commit 99ed878

Please sign in to comment.