Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
art049 committed Sep 12, 2023
1 parent c3aaa72 commit 87506ab
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions crates/cargo-codspeed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,27 @@ A cargo subcommand for running CodSpeed on your project

## Installation

### With `cargo-binstall`(recommended)

[`cargo-binstall`](https://github.com/cargo-bins/cargo-binstall) enables you to install binaries directly without having to build from the source(with `cargo install`) every time.

If you don't have installed yet, you can install it with:

```bash
cargo install cargo-codspeed
cargo install cargo-binstall
```

You can then install `cargo-codspeed` with:

```bash
cargo binstall cargo-codspeed
```

Feature `vendored-openssl` can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`.
### With `cargo`

```bash
cargo install cargo-codspeed
```

## Usage

Expand All @@ -30,3 +46,7 @@ Options:
-h, --help Print help information
-V, --version Print version information
```

## Advanced Usage

The `vendored-openssl` feature can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`.

0 comments on commit 87506ab

Please sign in to comment.