Skip to content

Commit 75e57b3

Browse files
committed
fix(metrics): fix Cargo.toml description and README installation note
- Update description field to accurately reflect Prometheus metrics purpose. - Add note that crate is not yet published on crates.io and show path dependency.
1 parent 394be7d commit 75e57b3

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

packages/metrics/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
description = "A library with the primitive types shared by the Torrust tracker packages."
2+
description = "Prometheus metrics integration library providing type-safe metric collection and aggregation."
33
keywords = [ "api", "library", "metrics" ]
44
name = "torrust-metrics"
55
readme = "README.md"

packages/metrics/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ This library offers a robust metrics system for tracking and monitoring applicat
2020

2121
Add this to your `Cargo.toml`:
2222

23+
> **Note**: This crate is not yet published on crates.io. Use a path or git dependency.
24+
2325
```toml
2426
[dependencies]
25-
torrust-metrics = "3.0.0"
27+
torrust-metrics = { path = "packages/metrics" }
2628
```
2729

2830
### Basic Usage

0 commit comments

Comments
 (0)