Skip to content

Commit

Permalink
docs: improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KoolTheba committed Oct 29, 2023
1 parent ade26f1 commit 7c337ca
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
Binary file modified .github/other/discrepancies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,29 @@ The Visualizer is part of the [OpenSSF Scorecard Monitor](https://github.com/Uli

## Features

**Scorecard Data Visualizer:** Display the OpenSSF Scorecard data in a visual format for easy understanding and analysis.
### Scorecard Data Visualizer

Display the OpenSSF Scorecard data in a visual format for easy understanding and analysis.

<br>
<div>
<img src='.github/other/demo1.gif' alt="visualizer-in-action"/>
</div>
</br>

**Scorecard Data Comparator:** Compare between two commits that reported Scorecard data. See how the scores changed and further details.
### Scorecard Data Comparator

Compare between two commits that reported Scorecard data. See how the scores changed and further details.

<br>
<div>
<img src='.github/other/gif_comparator.gif' alt="comparator-in-action"/>
</div>
</br>

**Scorecard Data Comparator Diff:** Makes easier the visualization of the differences in the Scorecard comparator reasoning and details.
### Scorecard Data Comparator Diff

Makes easier the visualization of the differences in the Scorecard comparator reasoning and details.

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

**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.
### 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.

<br>
<div>
<img src='.github/other/gitlab-support.png' alt="visualizer-for-gitlab-repos"/>
</div>
</br>

**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.
### 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.

<br>
<div>
Expand Down

0 comments on commit 7c337ca

Please sign in to comment.