Skip to content

Commit 07fb17d

Browse files
authored
Updated readme (#84)
* Updated readme * Update README.md
1 parent e67395b commit 07fb17d

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,17 @@ report.html – a clean, styled HTML report
4747

4848
---
4949

50+
# Keep using your regular pytest commands — just plug this in to unlock the below powerful reporting features with zero extra effort.
51+
5052
## ✨ Features
5153

5254
#### 🧩 Unified Test Reports: Get a single, easy-to-read HTML report summarizing all your test results — no hassle, just clarity.
5355

56+
#### Easily track Untracked test scenarios
57+
58+
![ScreenRecording2025-06-29at1 06 02AM-ezgif com-video-to-gif-converter](https://github.com/user-attachments/assets/af40622f-f548-44a5-982b-344c74a65e13)
59+
60+
5461
#### 🔄 Flaky Test Detection: Automatically flags flaky tests so you can spot and fix inconsistent failures quickly.
5562

5663
![ScreenRecording2025-06-21at2 37 31PM-ezgif com-video-to-gif-converter](https://github.com/user-attachments/assets/90f694bf-189c-45e1-8e1d-7acd2a975f91)
@@ -92,6 +99,10 @@ Just start typing, and the dashboard will instantly filter tests by:
9299

93100
This plugin is aimed at those who are:
94101

102+
- Tired of writing extra code just to generate reports or capture screenshots
103+
104+
- Manually attaching logs or outputs to test results
105+
95106
- Are frustrated with archiving folders full of assets, CSS, JS, and dashboards just to share test results.
96107

97108
- Don’t want to refactor existing test suites or tag everything with new decorators just to integrate with a reporting tool.
@@ -118,14 +129,6 @@ This plugin aims to fill those gaps by acting as a companion layer on top of the
118129

119130
🧼 Quickly copy test paths and run in your local
120131

121-
## 🔁 Flaky Test Detection
122-
123-
If a test is retried multiple times (e.g. due to a --reruns plugin), the report will flag it as FLAKY.
124-
125-
In the HTML report, you’ll see a badge like:
126-
127-
![Screenshot 2025-05-28 at 3 43 17 PM](https://github.com/user-attachments/assets/6fd7a419-58c1-4651-96f7-093ced1f02ee)
128-
129132
## 📧 Email Report (Optional)
130133

131134
Send the HTML report via email using --send-email. Please note you will need your own sendgrid setup to use this feature

0 commit comments

Comments
 (0)