chore: update readme

Author: art049

README.md

@@ -1 +1,8 @@
 # codspeed-rust
+
+This mono-repo contains the integration crates for using CodSpeed in Rust:
+
+- [`cargo-codspeed`](./crates/cargo-codspeed/): A cargo subcommand for running CodSpeed on your project
+- [`codspeed-criterion-compat`](./crates/criterion_compat/): Criterion.rs compatibility layer for CodSpeed
+- [`codspeed-bencher-compat`](./crates/bencher_compat/): Bencher compatibility layer for CodSpeed
+- [`codspeed`](./crates/codspeed/): The core library used to integrate with Codspeed runners

crates/bencher_compat/Cargo.toml

@@ -2,19 +2,19 @@
 name = "codspeed-bencher-compat"
 version = "0.1.1"
 edition = "2021"
-description = "bencher compatibility for CodSpeed"
+description = "Bencher compatibility layer for CodSpeed"
 authors = ["Arthur Pastel <[email protected]>"]
 documentation = "https://docs.codspeed.io"
 readme = "README.md"
-repository = "https://github.com/CodSpeedHQ/codspeed-rust"
+repository = "https://github.com/CodSpeedHQ/codspeed-rust/crates/bencher_compat"
 homepage = "https://codspeed.io"
 license = "Apache-2.0"
 categories = [
     "development-tools",
-    "development-tools::cargo-plugins",
     "development-tools::profiling",
     "development-tools::testing",
 ]
+keywords = ["codspeed", "benchmark", "bencher"]
 
 [dependencies]
 bencher = "0.1.5"

crates/cargo-codspeed/Cargo.toml

@@ -6,7 +6,7 @@ description = "Cargo extension to build & run your codspeed benchmarks"
 authors = ["Arthur Pastel <[email protected]>"]
 documentation = "https://docs.codspeed.io"
 readme = "README.md"
-repository = "https://github.com/CodSpeedHQ/codspeed-rust"
+repository = "https://github.com/CodSpeedHQ/codspeed-rust/crates/cargo-codspeed"
 homepage = "https://codspeed.io"
 license = "Apache-2.0"
 categories = [
@@ -15,7 +15,7 @@ categories = [
     "development-tools::profiling",
     "development-tools::testing",
 ]
-keywords = ["codspeed", "benchmark", "rust"]
+keywords = ["codspeed", "benchmark", "cargo"]
 
 [dependencies]
 cargo = "0.66.0"

crates/codspeed/Cargo.toml

@@ -6,16 +6,15 @@ description = "Core instrumentation library for CodSpeed"
 authors = ["Arthur Pastel <[email protected]>"]
 documentation = "https://docs.codspeed.io"
 readme = "README.md"
-repository = "https://github.com/CodSpeedHQ/codspeed-rust"
+repository = "https://github.com/CodSpeedHQ/codspeed-rust/crates/codspeed"
 homepage = "https://codspeed.io"
 license = "Apache-2.0"
 categories = [
     "development-tools",
-    "development-tools::cargo-plugins",
     "development-tools::profiling",
     "development-tools::testing",
 ]
-keywords = ["codspeed", "benchmark", "rust"]
+keywords = ["codspeed", "benchmark"]
 
 [dependencies]
 colored = "2.0.0"

crates/criterion_compat/Cargo.toml

@@ -2,19 +2,19 @@
 name = "codspeed-criterion-compat"
 version = "0.1.0"
 edition = "2021"
-description = "Criterion.rs compatibility for CodSpeed"
+description = "Criterion.rs compatibility layer for CodSpeed"
 authors = ["Arthur Pastel <[email protected]>"]
 documentation = "https://docs.codspeed.io"
 readme = "README.md"
-repository = "https://github.com/CodSpeedHQ/codspeed-rust"
+repository = "https://github.com/CodSpeedHQ/codspeed-rust/crates/criterion_compat"
 homepage = "https://codspeed.io"
 license = "Apache-2.0"
 categories = [
     "development-tools",
-    "development-tools::cargo-plugins",
     "development-tools::profiling",
     "development-tools::testing",
 ]
+keywords = ["codspeed", "benchmark", "criterion"]
 [dependencies]
 criterion = "0.4"
 codspeed = { path = "../codspeed", version = "0" }