Skip to content

Commit c5a655a

Browse files
authored
Merge pull request #53 from M-Zuber/patch-1
Fix markdown headers
2 parents a08f551 + ba45bd1 commit c5a655a

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
<img style="float: right;" align="right" height=64 src="https://raw.githubusercontent.com/HdrHistogram/HdrHistogram.NET/master/build/HdrHistogram-icon-64x64.png">
2-
#HdrHistogram
2+
# HdrHistogram
33
**A High Dynamic Range (HDR) Histogram**
44

55
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/HdrHistogram/HdrHistogram?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build status](https://ci.appveyor.com/api/projects/status/q0o5faahigq6u4qe/branch/master?svg=true)](https://ci.appveyor.com/project/LeeCampbell/hdrhistogram-net/branch/master) [![Build status](https://ci.appveyor.com/api/projects/status/q0o5faahigq6u4qe?svg=true)](https://ci.appveyor.com/project/LeeCampbell/hdrhistogram-net)
66

7-
##What is it
7+
## What is it
88
HdrHistogram.NET is the official port of the Java HdrHistogram library.
99
All official implementations of HdrHistogram can be found at https://github.com/HdrHistogram
1010

11-
##Why would I use it?
11+
## Why would I use it?
1212
You would use it to efficiently capture large number of response times measurements.
1313

1414
Often when measuring response times, one could make the common mistake of reporting on the mean value or the 90th percentile.
1515
Gil Tene (the original author of the Java HdrHistogram) illustrates in numerous presentations (such as [here](http://www.infoq.com/presentations/latency-pitfalls) and [here](https://www.youtube.com/watch?v=9MKY4KypBzg)) on why this is a mistake.
1616
Instead you want to collect all of the data and then be able to report your measurements across the range of measurements.
1717

18-
##How would I use it?
18+
## How would I use it?
1919
The library is available as a package from Nuget as [HdrHistogram](https://www.nuget.org/packages/HdrHistogram/)
2020

2121
Generally you want to be able to record at the finest accuracy the response-time of a given function of your software.
@@ -156,7 +156,7 @@ Instead of paying to cost of converting recorded values at the time of recording
156156
Use the helper methods to convert recorded values to standard units at output time, when performance is less critical.
157157

158158

159-
###Example of reporting results as a chart
159+
### Example of reporting results as a chart
160160
You can also have HdrHistogram output the results in a file format that can be charted.
161161
This is especially useful when comparing measurements.
162162

@@ -180,7 +180,7 @@ You can use either
180180
If you use the local tool, there are example result files in the _.\GoogleChartsExample_ directory.
181181
The tool also allows you to export to png.
182182

183-
##So what is so special about this way of recording response times?
183+
## So what is so special about this way of recording response times?
184184

185185
* itself is low latency
186186
* tiny foot print due to just storing a dynamic range of buckets and counts
@@ -247,7 +247,7 @@ histogram.OutputPercentileDistribution(
247247

248248

249249

250-
###How would I contribute to this project?
250+
### How would I contribute to this project?
251251
We welcome pull requests!
252252
If you do choose to contribute, please first raise an issue so we are not caught off guard by the pull request.
253253
Next can you please ensure that your PR (Pull Request) has a comment in it describing what it achieves and the issues that it closes.
@@ -401,7 +401,7 @@ The total footprint can be conservatively estimated by:
401401

402402
A conservative (high) estimate of a Histogram's footprint in bytes is available via the `GetEstimatedFootprintInBytes()` method.
403403

404-
##Terminology
404+
## Terminology
405405

406406
* **Latency** : The time that something is latent i.e. not being processed.
407407
This maybe due to being in a queue.

0 commit comments

Comments
 (0)