Skip to content

Commit 7c337ca

Browse files
committed
docs: improved documentation
1 parent ade26f1 commit 7c337ca

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

.github/other/discrepancies.png

-3.02 KB
Loading

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,29 @@ The Visualizer is part of the [OpenSSF Scorecard Monitor](https://github.com/Uli
66

77
## Features
88

9-
**Scorecard Data Visualizer:** Display the OpenSSF Scorecard data in a visual format for easy understanding and analysis.
9+
### Scorecard Data Visualizer
10+
11+
Display the OpenSSF Scorecard data in a visual format for easy understanding and analysis.
1012

1113
<br>
1214
<div>
1315
<img src='.github/other/demo1.gif' alt="visualizer-in-action"/>
1416
</div>
1517
</br>
1618

17-
**Scorecard Data Comparator:** Compare between two commits that reported Scorecard data. See how the scores changed and further details.
19+
### Scorecard Data Comparator
20+
21+
Compare between two commits that reported Scorecard data. See how the scores changed and further details.
1822

1923
<br>
2024
<div>
2125
<img src='.github/other/gif_comparator.gif' alt="comparator-in-action"/>
2226
</div>
2327
</br>
2428

25-
**Scorecard Data Comparator Diff:** Makes easier the visualization of the differences in the Scorecard comparator reasoning and details.
29+
### Scorecard Data Comparator Diff
30+
31+
Makes easier the visualization of the differences in the Scorecard comparator reasoning and details.
2632

2733
<br>
2834
<div>
@@ -33,15 +39,19 @@ The Visualizer is part of the [OpenSSF Scorecard Monitor](https://github.com/Uli
3339
</div>
3440
</br>
3541

36-
**Support to GitLab repositories:** The project provides support of visualization and diff comparation for GitLab projects. In the GitLab version, deps.dev and step security links are not included, as those platforms don't support GitLab projects yet.
42+
### Support to GitLab repositories
43+
44+
The project provides support of visualization and diff comparation for GitLab projects. In the GitLab version, deps.dev and step security links are not included, as those platforms don't support GitLab projects yet.
3745

3846
<br>
3947
<div>
4048
<img src='.github/other/gitlab-support.png' alt="visualizer-for-gitlab-repos"/>
4149
</div>
4250
</br>
4351

44-
**Discrepancies management:** The Scorecard API can provide discrepancies in the data while comparing between two commits due [technical reasons](https://github.com/ossf/scorecard/issues/3438). The visualizer provides a way to showcase the discrepancies found.
52+
### Discrepancies management
53+
54+
The Scorecard API can provide discrepancies in the data while comparing between two commits due [technical reasons](https://github.com/ossf/scorecard/issues/3438). The visualizer provides a way to showcase the discrepancies found.
4555

4656
<br>
4757
<div>

0 commit comments

Comments
 (0)