Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreyAkinshin committed Apr 4, 2020
1 parent 7902cd6 commit fd4c320
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@

**BenchmarkDotNet** helps you to transform methods into benchmarks, track their performance, and share reproducible measurement experiments.
It's no harder than writing unit tests!
Under the hood, it performs a lot of [magic](#Automation) that guarantees [reliable and precise](#Reliability) results.
Under the hood, it performs a lot of [magic](#Automation) that guarantees [reliable and precise](#Reliability) results thanks to the [perfolizer](https://github.com/AndreyAkinshin/perfolizer) statistical engine.
BenchmarkDotNet protects you from popular benchmarking mistakes and warns you if something is wrong with your benchmark design or obtained measurements.
The results are presented in a [user-friendly](#Friendliness) form that highlights all the important facts about your experiment.
The library is adopted by [3500+ projects](#who-use-benchmarkdotnet) including .NET Core and supported by the [.NET Foundation](https://dotnetfoundation.org).
The library is adopted by [3800+ projects](#who-use-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org).

It's [easy](#Simplicity) to start writing benchmarks, check out an example
(copy-pastable version is [here](https://benchmarkdotnet.org/articles/guides/getting-started.html)):
Expand Down Expand Up @@ -107,7 +107,7 @@ The measured data can be exported to different formats (md, html, csv, xml, json

![](docs/images/v0.12.0/rplot.png)

*Supported runtimes:* .NET Framework 4.6.1+, .NET Core 2.0+, Mono, CoreRT
*Supported runtimes:* .NET 5+, .NET Framework 4.6.1+, .NET Core 2.0+, Mono, CoreRT
*Supported languages:* C#, F#, Visual Basic
*Supported OS:* Windows, Linux, macOS

Expand Down Expand Up @@ -236,7 +236,7 @@ If you don't customize the summary view,
## Who use BenchmarkDotNet?

Everyone!
BenchmarkDotNet is already adopted by more than [3500+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including
BenchmarkDotNet is already adopted by more than [3800+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including
[dotnet/performance](https://github.com/dotnet/performance) (reference benchmarks for all .NET Runtimes),
[dotnet/runtime](https://github.com/dotnet/runtime/issues?utf8=%E2%9C%93&q=BenchmarkDotNet) (.NET Core runtime and libraries),
[Roslyn](https://github.com/dotnet/roslyn/search?q=BenchmarkDotNet&type=Issues&utf8=✓) (C# and Visual Basic compiler),
Expand Down Expand Up @@ -266,11 +266,12 @@ BenchmarkDotNet is already adopted by more than [3500+](https://github.com/dotne
[LiteDB](https://github.com/mbdavid/LiteDB/tree/master/LiteDB.Benchmarks),
[GraphQL for .NET](https://github.com/graphql-dotnet/graphql-dotnet/tree/master/src/GraphQL.Benchmarks),
[MediatR](https://github.com/jbogard/MediatR/tree/master/test/MediatR.Benchmarks),
[TensorFlow.NET](https://github.com/SciSharp/TensorFlow.NET/tree/master/src/TensorFlowNet.Benchmarks).
[TensorFlow.NET](https://github.com/SciSharp/TensorFlow.NET/tree/master/src/TensorFlowNet.Benchmarks),
[Apache Thrift](https://github.com/apache/thrift/tree/master/lib/netstd/Benchmarks/Thrift.Benchmarks).
On GitHub, you can find
2500+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓),
1500+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and
450,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓)
3000+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓),
1800+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and
500,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓)
that involve BenchmarkDotNet.

## Learn more about benchmarking
Expand Down

0 comments on commit fd4c320

Please sign in to comment.