Skip to content

Commit 00e8ff3

Browse files
authored
updating README to fix link to documentation (#21)
1 parent 44003dc commit 00e8ff3

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Histogram is a port of Gil Tene's [High Dynamic Range (HDR) Histogram](http://hd
1010

1111
Histogram supports the recording and analyzing of sampled data value counts across a configurable integer value range with configurable value precision within the range. Value precision is expressed as the number of significant digits in the value recording, and provides control over value quantization behavior across the value range and the subsequent value resolution at any given level.
1212

13-
For example, a Histogram could be configured to track the counts of observed integer values between 0 and 3,600,000,000 while maintaining a value precision of 3 significant digits across that range. Value quantization within the range will thus be no larger than 1/1,000th (or 0.1%) of any value.
13+
For example, a Histogram could be configured to track the counts of observed integer values between 0 and 3,600,000,000 while maintaining a value precision of 3 significant digits across that range. Value quantization within the range will thus be no larger than 1/1,000th (or 0.1%) of any value.
1414

1515
This example Histogram could be used to track and analyze the counts of observed response times ranging between 1 microsecond and 1 hour in magnitude, while maintaining a value resolution of 1 microsecond up to 1 millisecond, a resolution of 1 millisecond (or better) up to one second, and a resolution of 1 second (or better) up to 1,000 seconds. At it's maximum tracked value (1 hour), it would still maintain a resolution of 3.6 seconds (or better).
1616

@@ -33,29 +33,32 @@ Users are encouraged to read the documentation from the original [Java implement
3333
as most of the concepts translate directly to the Swift port. Additional Thanks to the maintainers of the Rust port for a nice introduction to the package that we've largely borrowed.
3434

3535
# Adding dependencies
36+
3637
To add to your project:
37-
```
38+
39+
```swift
3840
dependencies: [
3941
.package(url: "https://github.com/HdrHistogram/hdrhistogram-swift", .upToNextMajor(from: "0.1.0"))
4042
]
4143
```
4244

4345
and then add the dependency to your target, e.g.:
4446

45-
```
47+
```swift
4648
.executableTarget(
4749
name: "MyExecutableTarget",
4850
dependencies: [
4951
.product(name: "Histogram", package: "hdrhistogram-swift")
5052
]),
5153
```
54+
5255
## Usage
5356

54-
The Histogram API follows that of the original HdrHistogram Java implementation, with some modifications to make its use more idiomatic in Swift.
57+
The Histogram API follows that of the original HdrHistogram Java implementation, with some modifications to make its use more idiomatic in Swift.
5558

56-
[Documentation for the classes and API](https://swiftpackageindex.com/ordo-one/package-histogram/main/documentation/Histogram) are hosted by the [SwiftPackageIndex](http://www.swiftpackageindex.com)
59+
[Documentation for the classes and API](https://swiftpackageindex.com/HdrHistogram/hdrhistogram-swift/documentation/histogram) are hosted by the [SwiftPackageIndex](http://www.swiftpackageindex.com)
5760

58-
# Simple example
61+
# Simple example
5962

6063
(see implementation in Sources/HistogramExample)
6164

@@ -100,4 +103,3 @@ print("stddev: \(histogram.stdDeviation)")
100103

101104
print("\(histogram)")
102105
```
103-

0 commit comments

Comments
 (0)