Skip to content

Commit 8397bcd

Browse files
thatdevsherryLuca Bruno
andauthored
Update "features" section in README (#346)
* Modify "feature" section in README Change wording in feature section to indicate that there are some crate features that need to be enabled before they can be utilized Signed-off-by: Shehriyar Qureshi <[email protected]> * Run markdownlinter on README.md Signed-off-by: Shehriyar Qureshi <[email protected]> * Add link for push metrics word Link to push metrics documentation in prometheus docs to show what push metrics support actually is Signed-off-by: Shehriyar Qureshi <[email protected]> * Apply suggestions from code review Co-authored-by: Luca Bruno <[email protected]> Signed-off-by: Shehriyar Qureshi <[email protected]> Co-authored-by: Luca Bruno <[email protected]>
1 parent b2f473d commit 8397bcd

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,24 @@ This is the [Rust](https://www.rust-lang.org) client library for
88
[Prometheus](http://prometheus.io). The main data structures and APIs are ported
99
from [Go client](https://github.com/prometheus/client_golang).
1010

11-
1211
## Documentation
1312

14-
Find the latest documentation at https://docs.rs/prometheus
15-
13+
Find the latest documentation at <https://docs.rs/prometheus>.
1614

1715
## Advanced
1816

19-
### Features
17+
### Crate features
2018

21-
This library supports four features:
19+
This crate provides several optional components which can be enabled via [Cargo `[features]`](https://doc.rust-lang.org/cargo/reference/features.html):
2220

2321
- `gen`: To generate protobuf client with the latest protobuf version instead of
2422
using the pre-generated client.
2523

2624
- `nightly`: Enable nightly only features.
2725

28-
- `process`: For collecting process info.
29-
30-
- `push`: Enable push support.
26+
- `process`: Enable [process metrics](https://prometheus.io/docs/instrumenting/writing_clientlibs/#process-metrics) support.
3127

28+
- `push`: Enable [push metrics](https://prometheus.io/docs/instrumenting/pushing/) support.
3229

3330
### Static Metric
3431

@@ -38,7 +35,6 @@ prometheus-static-metric reduces the overhead of retrieving the concrete
3835

3936
See [static-metric](./static-metric) directory for details.
4037

41-
4238
## Thanks
4339

4440
- [brian-brazil](https://github.com/brian-brazil)

0 commit comments

Comments
 (0)