Skip to content

Commit 870e5d6

Browse files
Add screenshots to readme
1 parent 3ab5102 commit 870e5d6

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,16 @@ spec-score validate <file|url>
5353
**Examples:**
5454

5555
```bash
56-
spec-score validate ./api/openapi.yaml
56+
spec-score validate spec.yaml
5757
spec-score validate https://petstore3.swagger.io/api/v3/openapi.json
5858
```
5959

60+
<img src="https://github.com/user-attachments/assets/2391cbf3-f6b8-49f4-99b8-992b030cb923" width="500" />
61+
62+
<br/>
63+
<br/>
64+
65+
6066
**Output includes:**
6167

6268
- Document parsing and validation status
@@ -89,6 +95,7 @@ spec-score report ./openapi.yaml -f markdown -o api-report.md
8995
# HTML report
9096
spec-score report ./openapi.yaml -f html -o api-report.html
9197
```
98+
<img src="https://github.com/user-attachments/assets/5e5b7ba1-8d81-49d0-b147-460f4e1a793b" width="500" height="450"/>
9299

93100
## Scoring Criteria
94101

0 commit comments

Comments
 (0)