Skip to content
This repository has been archived by the owner on Oct 13, 2023. It is now read-only.

Commit

Permalink
Add why paragraph to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
svartalf authored Mar 30, 2020
1 parent 3f2d9e8 commit 7c7ad50
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This GitHub Action provides faster version of the `cargo install` command.

**Table of Contents**

* [Why?](#why)
* [How does this works?](#how-does-it-work)
* [Example workflow](#example-workflow)
* [Inputs](#inputs)
Expand All @@ -21,6 +22,12 @@ This GitHub Action provides faster version of the `cargo install` command.
* [License](#license)
* [Contribute and support](#contribute-and-support)

## Why?

If you are using binary crates (such as [`cargo-audit`](https://crates.io/crates/cargo-audit), [`grcov`](https://github.com/mozilla/grcov), [`cargo-geiger`](https://crates.io/crates/cargo-geiger) and so on) in your CI workflows, you might have noticed that compiling these crates each time is irritatingly slow.

This Action speeds up the crates installation with some tricks, leading to a much faster job execution; crates are expected to be installed in a couple seconds.

## How does it work?

Before calling your usual `cargo install` command, this Action
Expand Down

0 comments on commit 7c7ad50

Please sign in to comment.