Skip to content

Commit 9c7e444

Browse files
committed
update: adopt a more concise README style
Signed-off-by: Melissa Kilby <[email protected]>
1 parent 96d854f commit 9c7e444

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,35 @@
33
[![sswg:sandbox](https://img.shields.io/badge/sswg-sandbox-yellow.svg)][SSWG-Incubation]
44
[![Documentation](http://img.shields.io/badge/read_the-docs-2196f3.svg)][Documentation]
55

6-
A Swift client for the [Prometheus](https://github.com/prometheus/prometheus) monitoring system,
7-
supporting counters, gauges and histograms. Swift Prometheus
8-
implements the Swift Metrics API.
6+
A Swift client library for [Prometheus Monitoring System](https://github.com/prometheus/prometheus).
97

10-
## Security
8+
`swift-prometheus` supports creating `Counter`s, `Gauge`s and `Histogram`s, updating metric values, and exposing their values in the Prometheus text format.
119

12-
Please see [SECURITY.md](SECURITY.md) for details on the security process.
10+
## Installation and Usage
1311

14-
## Contributing
12+
Please refer to the [Documentation][Documentation] for installation, usage instructions, and implementation details including Prometheus standards compliance.
1513

16-
All contributions are most welcome!
14+
For general Prometheus guidance, see [Prometheus Monitoring System][prometheus-docs].
1715

18-
If you think of some cool new feature that should be included, please [create an issue](https://github.com/swift-server/swift-prometheus/issues/new).
19-
Or, if you want to implement it yourself, [fork this repo](https://github.com/swift-server/swift-prometheus/fork) and submit a PR!
16+
## Security
2017

21-
If you find a bug or have issues, please [create an issue](https://github.com/swift-server-community/SwiftPrometheus/issues/new) explaining your problems. Please include as much information as possible, so it's easier for us to reproduce (Framework, OS, Swift version, terminal output, etc.)
18+
Please see [SECURITY.md](SECURITY.md) for details on the security process.
2219

23-
[Documentation]: https://swiftpackageindex.com/swift-server/swift-prometheus/documentation/prometheus
24-
[SSWG-Incubation]: https://www.swift.org/sswg/incubation-process.html
20+
## Contributing
2521

22+
We welcome all contributions to `swift-prometheus`! For feature requests or bug reports, please [create an issue](https://github.com/swift-server/swift-prometheus/issues/new) with detailed information including Swift version, platform, and reproduction steps. To contribute code, [fork this repo](https://github.com/swift-server/swift-prometheus/fork) and submit a pull request with tests and documentation updates.
2623

2724
## Benchmarks
2825

29-
Benchmarks for `swift-prometheus` are in a separate Swift Package in the `Benchmarks` subfolder of this repository.
30-
They use the [`package-benchmark`](https://github.com/ordo-one/package-benchmark) plugin.
31-
Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `package-benchmark` to capture memory allocation statistics.
32-
An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `package-benchmark`.
33-
Afterwards you can run the benchmarks from CLI by going to the `Benchmarks` subfolder (e.g. `cd Benchmarks`) and invoking:
26+
Benchmarks are located in the [Benchmarks](/Benchmarks/) subfolder and use the [`package-benchmark`](https://github.com/ordo-one/package-benchmark) plugin. See the [Benchmarks Getting Started]((https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support)) guide for installation instructions. Run benchmarks by navigating to Benchmarks and executing:
27+
3428
```
3529
swift package benchmark
3630
```
3731

38-
For more information please refer to `swift package benchmark --help` or the [documentation of `package-benchmark`](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark).
32+
For more information please refer to `swift package benchmark --help` or the [`package-benchmark` Documentation](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark).
33+
34+
35+
[Documentation]: https://swiftpackageindex.com/swift-server/swift-prometheus/documentation/prometheus
36+
[prometheus-docs]: https://prometheus.io/docs/introduction/overview/
37+
[SSWG-Incubation]: https://www.swift.org/sswg/incubation-process.html

Sources/Prometheus/Docs.docc/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ``Prometheus``
22

3-
A prometheus client library for Swift.
3+
A Swift client library for the Prometheus Monitoring System.
44

55
## Overview
66

@@ -13,7 +13,7 @@ A prometheus client library for Swift.
1313
- *Thread Safe and Type-Safe*.
1414
- *Swift Metrics Compatible*: Use the native Prometheus client API implemented in this library or use [Swift Metrics](doc:swift-metrics) as a backend for this library.
1515

16-
For general Prometheus guidance, see the [Prometheus Documentation][prometheus-docs].
16+
For general Prometheus guidance, see the [Prometheus Monitoring System Documentation][prometheus-docs].
1717

1818
## Installation
1919

0 commit comments

Comments
 (0)