Skip to content

Commit d16ccfa

Browse files
committed
docs
1 parent 9066c0a commit d16ccfa

File tree

1 file changed

+12
-22
lines changed

1 file changed

+12
-22
lines changed

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ You can support the project by:
1919
- Giving this repository a ⭐
2020
- [Following the @ctrf organization on GitHub](https://github.com/ctrf-io)
2121

22+
## Example
23+
24+
<div align="center">
25+
<img src="images/github-readme.png" alt="GitHub Test Reporter" width="600">
26+
</div>
27+
2228
## Key Features
2329

2430
**🧩 Post anywhere:** job summaries, pull requests, checks, issues, inline annotations, and other developer tools
@@ -33,12 +39,11 @@ You can support the project by:
3339

3440
## Table of Contents
3541

36-
1. [Basic Usage](#basic-usage)
37-
2. [Insights Usage](#insights-usage)
42+
1. [Usage](#usage)
3843
2. [Report Showcase](#report-showcase)
3944
3. [Visual Overview](#visual-overview)
4045
4. [Available Inputs](#available-inputs)
41-
5. [Continuous AI](#continuous-ai)
46+
5. [Generating an AI Report](#generating-an-ai-report)
4247
6. [Pull Requests](#pull-requests)
4348
7. [Status Checks](#status-checks)
4449
8. [Build Your Own Report](#build-your-own-report)
@@ -50,7 +55,7 @@ You can support the project by:
5055
14. [Integrations](#integrations)
5156
15. [What is CTRF?](#what-is-ctrf)
5257

53-
## Basic Usage
58+
## Usage
5459

5560
To get started add the following to your workflow file:
5661

@@ -63,22 +68,6 @@ To get started add the following to your workflow file:
6368
if: always()
6469
```
6570
66-
<div align="center">
67-
<img src="images/github-readme.png" alt="GitHub Test Reporter" width="600">
68-
</div>
69-
70-
## Insights Usage
71-
72-
```yaml
73-
- name: Publish Test Report
74-
uses: ctrf-io/github-test-reporter@v1
75-
with:
76-
report-path: './ctrf/*.json'
77-
github-report: true
78-
if: always()
79-
```
80-
81-
8271
## Report Showcase
8372
8473
Checkout the [built-in reports](docs/report-showcase.md)
@@ -125,6 +114,7 @@ For more advanced usage, there are several inputs available.
125114
insights-report: false
126115
slowest-report: false
127116
ai-report: false
117+
ai-summary-report: false
128118
skipped-report: false
129119
suite-folded-report: false
130120
suite-list-report: false
@@ -174,7 +164,7 @@ For more advanced usage, there are several inputs available.
174164
175165
Only `report-path` is required.
176166

177-
## Continuous AI
167+
## Generating an AI Report
178168

179169
You can generate human-readable AI reports for your failed tests using models
180170
from the leading AI providers. The GitHub Test Reporter now features dedicated
@@ -508,4 +498,4 @@ analyzing test outcomes across multiple platforms becomes more straightforward.
508498
## Support Us
509499

510500
If you find this project useful, consider giving it a GitHub star ⭐ It means a
511-
lot to us.
501+
lot to us.

0 commit comments

Comments
 (0)