Skip to content

Commit

Permalink
Merge pull request #1402 from step-security/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
varunsh-coder committed Nov 13, 2022
2 parents adaff53 + 072907b commit 4b5d969
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 17 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,26 @@
<p align="center"><img src="images/banner.png" height="80" /></p>

<h1 align="center">Secure Workflows</h1>

<p align="center">
<picture>
<source media="(prefers-color-scheme: light)" srcset="images/banner.png" width="400">
<img src="images/banner.png" width="400">
</picture>
Secure GitHub Actions CI/CD workflows via automated remediations
</p>

<div align="center">

[![Maintained by stepsecurity.io](https://img.shields.io/badge/maintained%20by-stepsecurity.io-blueviolet)](https://stepsecurity.io/?utm_source=github&utm_medium=organic_oss&utm_campaign=secure-workflows)
[![Go Report Card](https://goreportcard.com/badge/github.com/step-security/secure-workflows)](https://goreportcard.com/report/github.com/step-security/secure-workflows)
[![codecov](https://codecov.io/gh/step-security/secure-workflows/branch/main/graph/badge.svg?token=02ONA6U92A)](https://codecov.io/gh/step-security/secure-workflows)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/step-security/secure-workflows/badge)](https://api.securityscorecards.dev/projects/github.com/step-security/secure-workflows)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://raw.githubusercontent.com/step-security/secure-workflows/main/LICENSE)

</div>

<p align="center">
Secure GitHub Actions CI/CD workflows via automated remediations
</p>

<p align="center">
<img src="https://github.com/step-security/supply-chain-goat/blob/main/images/secure-repo.gif" alt="Secure repo screenshot" >
</p>

<h3>
<a href="#quickstart">Quickstart</a>
<span> • </span>
<a href="#impact">Impact</a>
<span> • </span>
<a href="#functionality-overview">Functionality Overview</a>
<span> • </span>
Expand Down Expand Up @@ -56,14 +51,9 @@ To secure GitHub Actions workflows using a pull request:

To create an instance of Secure Workflows, deploy _cloudformation/ecr.yml_ and _cloudformation/resources.yml_ CloudFormation templates in your AWS account. You can take a look at _.github/workflows/release.yml_ for reference.

## Impact

- SecureWorkflows has been used to [secure 30 of the top 100 critical open source projects](https://github.com/step-security/secure-workflows/issues/462)
- SecureWorkflows was demoed at `SupplyChainSecurityCon` at [Open Source Summit North America 2022](http://sched.co/11Pvu)

## Functionality Overview

SecureWorkflows API
Secure Workflows

- Takes in a GitHub Actions workflow YAML file as an input
- Returns a transformed workflow file with fixes applied
Expand Down
Binary file modified images/banner.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 4b5d969

Please sign in to comment.