Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lukehinds committed Apr 23, 2024
1 parent 4639680 commit 96ee397
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Trusty Dependency Analysis Action

Get a security and quality analysis of your dependencies with TrustyPkg!

![alt text](image.png)

## Features

* Check if the dependencies are malicious or deprecated
* Assess the quality and security of your dependencies using TrustyPkg
activity hueristics
* See if it contains a source of origin to a legitimate code repository using
sigstore and Trusty's historical provenance algorithm
* Understand if the package is a possible typo squatting attack
* Get a list of recommended alternatives to the dependency

## Overview

This action takes any added dependencies within a pull request and assesses their
quality using the [Trusty](https://trustypkg.dev/) API. If any dependencies are
found to be below a certain threshold (See details below), the action will fail.
Expand All @@ -14,6 +30,7 @@ Full Language Support (inline with Trusty):
* Rust
* Go


## Usage

To use this action, you can add the following to your workflow:
Expand Down
Binary file added docs/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 96ee397

Please sign in to comment.