wip

Author: art049

README.md

@@ -12,11 +12,11 @@
 <br/>
 
 <p align="center">
-  <a href="https://github.com/CodSpeedHQ/runner/releases/latest"><img src="https://img.shields.io/github/v/release/CodSpeedHQ/runner" alt="Latest Release"></a>
-  <a href="https://github.com/CodSpeedHQ/runner/releases"><img src="https://img.shields.io/github/downloads/CodSpeedHQ/runner/total?logo=github" alt="Downloads"></a>
-  <a href="https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/CodSpeedHQ/runner/ci.yml?branch=main&logo=github&label=CI" alt="CI Status"></a>
-  <a href="https://github.com/CodSpeedHQ/runner/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/github/license/CodSpeedHQ/runner" alt="License"></a>
-  <a href="https://discord.com/invite/MxpaCfKSqF"><img src="https://img.shields.io/badge/chat%20on-discord-7289da.svg" alt="Discord Chat"></a>
+  <a href="https://github.com/CodSpeedHQ/codspeed/releases/latest"><img src="https://img.shields.io/github/v/release/CodSpeedHQ/codspeed" alt="Latest Release"></a>
+  <a href="https://github.com/CodSpeedHQ/codspeed/releases"><img src="https://img.shields.io/github/downloads/CodSpeedHQ/codspeed/total?logo=github" alt="Downloads"></a>
+  <a href="https://github.com/CodSpeedHQ/codspeed/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/CodSpeedHQ/codspeed/ci.yml?branch=main&logo=github&label=CI" alt="CI Status"></a>
+  <a href="https://github.com/CodSpeedHQ/codspeed/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/github/license/CodSpeedHQ/codspeed" alt="License"></a>
+  <a href="https://codspeed.io/discord"><img src="https://img.shields.io/badge/chat%20on-discord-7289da.svg" alt="Discord Chat"></a>
   <a href="https://codspeed.io/?utm_source=badge"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed Badge"></a>
 </p>
 
@@ -26,18 +26,16 @@
 - 🔥 **Differential flamegraphs** to pinpoint exactly what got slower, commit by commit.
 - 💬 **PR comments & status checks** showing performance impact directly in your workflow.
 - 🛡️ **Merge protection** to block PRs that degrade performance beyond your threshold.
-- 🐍 **Multi-language support** for Python, Rust, Node.js, Go, and C/C++.
+- 🐍 **Multi-language support** for Python, Rust, Node.js, Go, C/C++ and more.
 - 🏠 **Run locally or in CI** - works on your machine and integrates with GitHub Actions, GitLab CI, and more.
 - 🔌 **Plug your existing benchmarks** in less than 5 minutes - works with pytest, vitest, criterion, and more.
 
 ## Installation
 
 ```bash
-curl -fsSL https://codspeed.io/install.sh | sh
+curl -fsSL https://codspeed.io/install.sh | bash
 ```
 
-Refer to the [releases page](https://github.com/CodSpeedHQ/codspeed/releases) to see all available versions.
-
 ## Usage
 
 > [!NOTE]
@@ -64,6 +62,25 @@ codspeed run pytest ./tests --codspeed
 codspeed run pnpm vitest bench
 ```
 
+## In CI environments
+
+To run CodSpeed in Github Actions, we recommend using our official GitHub Action: [@CodSpeedHQ/action](https://github.com/CodSpeedHQ/action).
+
+## Languages Integrations
+
+On top of the generic CLI, CodSpeed provides first-class integrations for multiple languages and frameworks:
+
+| Language        | Repository                                                       | Supported Frameworks                  |
+| --------------- | ---------------------------------------------------------------- | ------------------------------------- |
+| Rust            | [codspeed-rust](https://github.com/CodSpeedHQ/codspeed-rust)     | `divan`, `criterion.rs`, `bencher`    |
+| C/C++           | [codspeed-cpp](https://github.com/CodSpeedHQ/codspeed-cpp)       | `google-benchmark`                    |
+| Python          | [pytest-codspeed](https://github.com/CodSpeedHQ/pytest-codspeed) | `pytest` plugin                       |
+| Node.js         | [codspeed-node](https://github.com/CodSpeedHQ/codspeed-node)     | `vitest`, `tinybench`, `benchmark.js` |
+| Go              | [codspeed-go](https://github.com/CodSpeedHQ/codspeed-go)         | builtin `testing` package integration |
+| Zig (community) | [codspeed-zig](https://github.com/james-elicx/codspeed-zig)      | custom                                |
+
+Need to bench another language or framework? Open [an issue](https://github.com/CodSpeedHQ/codspeed/issues) or let us know on [Discord](https://codspeed.io/discord)!
+
 ## Advanced usage
 
 ### Installing tools before running
@@ -76,14 +93,6 @@ codspeed setup
 
 This is especially useful when configuring environments with tools such as docker.
 
-### Logging level
-
-Use the `CODSPEED_LOG` environment variable to set the logging level:
-
-```bash
-CODSPEED_LOG=debug codspeed run ...
-```
-
 ### Changing the mode of the runner
 
 By default, the runner will run the benchmark in the `simulation` mode. You can specify the mode with the `--mode` flag of the `run` command:
@@ -97,6 +106,5 @@ codspeed run --mode walltime <my-benchmark-command>
 ```
 
 > [!WARNING]
-> We strongly recommend not changing this mode unless you know what you are doing.
 > Using the `walltime` mode on traditional VMs/Hosted Runners will lead to inconsistent data. For the best results, we recommend using CodSpeed Hosted Macro Runners, which are fine-tuned for performance measurement consistency.
 > Check out the [Walltime Instrument Documentation](https://docs.codspeed.io/instruments/walltime/) for more details.