Skip to content

Commit f9b51d9

Browse files
committed
docs: reorder
1 parent 353349e commit f9b51d9

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,6 @@ A Go JSON test reporter to create test reports that follow the CTRF standard.
4949
}
5050
```
5151

52-
## What is CTRF?
53-
54-
CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
55-
56-
**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
57-
58-
**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
59-
60-
**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
61-
6252
## Installation
6353

6454
To install go-ctrf-json-reporter, ensure you have Go installed on your system, then run:
@@ -126,7 +116,6 @@ The test object in the report includes the following [CTRF properties](https://c
126116

127117
| Name | Type | Required | Details |
128118
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |
129-
| `suite` | String | Required | The name of go package containing the test. |
130119
| `name` | String | Required | The name of the test. |
131120
| `status` | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |
132121
| `duration` | Number | Required | The time taken for the test execution, in milliseconds. |
@@ -137,6 +126,16 @@ The test object in the report includes the following [CTRF properties](https://c
137126

138127
When running go-ctrf-json-reporter results in a "command not found" error this usually means that the Go bin directory is not in your system's PATH.
139128

129+
## What is CTRF?
130+
131+
CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
132+
133+
**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
134+
135+
**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
136+
137+
**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
138+
140139
## Support Us
141140

142141
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

0 commit comments

Comments
 (0)