Skip to content

Commit c6dd0cf

Browse files
committed
docs: updated README with comparator diff section
1 parent a6d3270 commit c6dd0cf

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

.github/other/comparator-diff1.png

35.9 KB
Loading

.github/other/comparator-diff2.png

222 KB
Loading

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,24 @@ The Visualizer is part of the [OpenSSF Scorecard Monitor](https://github.com/Uli
2222
</div>
2323
</br>
2424

25+
**Scorecard Data Comparator Diff:** Makes easier the visualization of the differences in the Scorecard comparator reasoning and details.
26+
27+
<br>
28+
<div>
29+
<img src='.github/other/comparator-diff1.png' alt="comparator-diff-reasoning"/>
30+
</div>
31+
<div>
32+
<img src='.github/other/comparator-diff2.png' alt="comparator-diff-details"/>
33+
</div>
34+
</br>
35+
2536
## How to use it
2637

2738
The Visualizer and the Comparator can be used outside the Monitor.
2839

2940
You have 3 options of visualization. Depending on which one you want to check, you should craft your own url as:
3041

31-
- Checks the latest Scorecard data available for a project: `https://kooltheba.github.io/openssf-scorecard-api-visualizer//projects/${platform}/${org}/${repo}`
42+
- Checks the latest Scorecard data available for a project: `https://kooltheba.github.io/openssf-scorecard-api-visualizer/#/projects/${platform}/${org}/${repo}`
3243
- Checks the Scorecard data for an specific commit (previously reported): `https://kooltheba.github.io/openssf-scorecard-api-visualizer/#/projects/${platform}/${org}/${repo}/commit/{commitHash}`
3344
- Compares two specific commits, previously reported: `https://kooltheba.github.io/openssf-scorecard-api-visualizer/#/projects/github.com/nodejs/node/compare/{prevCommitHash}/{currentCommitHash}`
3445

0 commit comments

Comments
 (0)