Skip to content

Commit 85777a6

Browse files
art049adriencaccia
authored andcommitted
chore: update README.md
1 parent 306c799 commit 85777a6

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<h1><code>codspeed-runner</code></h1>
33

4-
CLI to gather performance data and upload performance reports to [CodSpeed](https://codspeed.io)
4+
CLI to gather performance data from CI environments and upload performance reports to [CodSpeed](https://codspeed.io)
55

66
[![CI](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml)
77
[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
@@ -12,14 +12,14 @@ The `codspeed-runner` CLI is designed to be used in CI environments.
1212

1313
The following providers are supported:
1414

15-
- [GitHub Actions](https://docs.codspeed.io/ci/github-actions)
15+
- [GitHub Actions](https://docs.codspeed.io/ci/github-actions): Usage with [`@CodSpeedHQ/action`](https://github.com/CodSpeedHQ/action) is recommended.
1616
- [Buildkite](https://docs.codspeed.io/ci/buildkite)
1717

1818
#### Other providers
1919

20-
If you want to use the CLI with another provider, you can open an issue and/or chat with us on [Discord](https://discord.com/invite/MxpaCfKSqF) 🚀
20+
If you want to use the CLI with another provider, you can open an issue or chat with us on [Discord](https://discord.com/invite/MxpaCfKSqF) 🚀
2121

22-
You can check out the implementation of the GitHub Actions and Buildkite integrations for reference: https://github.com/CodSpeedHQ/runner/tree/main/src/ci_provider.
22+
You can check out the implementation of the [supported providers](https://github.com/CodSpeedHQ/runner/tree/main/src/ci_provider) for reference.
2323

2424
## Installation
2525

0 commit comments

Comments
 (0)