diff --git a/README.md b/README.md index bc74237..8703c88 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,37 @@ Full Language Support (inline with Trusty): * Rust * Go +## Usage + +To use this action, you can add the following to your workflow: + +```yaml +name: TrustyPkg Dependency Check + +on: + pull_request: + branches: + - main + +jobs: + trusty_pkg_check: + runs-on: ubuntu-latest + name: Check Dependencies with TrustyPkg + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: TrustyPkg Action + uses: stacklok/trusty-action@v0.0.1 + with: + score_threshold: 5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + ## Inputs -Only one input is required for this action: +Only one input is available for this action: `score_threshold`: The minimum score required for a dependency to be considered high quality. Anything below this score will fail the action. \ No newline at end of file