Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreyAkinshin committed May 19, 2021
1 parent a79339c commit 18e2926
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 21 deletions.
22 changes: 11 additions & 11 deletions README.md
Expand Up @@ -29,7 +29,7 @@ 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 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 [4500+ projects](#who-use-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org).
The library is adopted by [6800+ projects](#who-uses-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 @@ -109,7 +109,7 @@ The measured data can be exported to different formats (md, html, csv, xml, json

*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
*Supported OS:* Windows, Linux, macOS
*Supported architectures:* x86, x64, ARM, ARM64 and Wasm

## Features
Expand Down Expand Up @@ -228,33 +228,33 @@ Of course, you can request any additional statistics and visualizations manually
If you don't customize the summary view,
the default presentation will be as much user-friendly as possible. :)

## Who use BenchmarkDotNet?
## Who uses BenchmarkDotNet?

Everyone!
BenchmarkDotNet is already adopted by more than [4500+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including
BenchmarkDotNet is already adopted by more than [6800+](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),
[Mono](https://github.com/mono/mono/tree/master/sdks/wasm/bench-runner),
[ASP.NET Core](https://github.com/aspnet/AspNetCore/tree/master/src/Servers/IIS/IIS/benchmarks),
[ML.NET](https://github.com/dotnet/machinelearning/tree/master/test/Microsoft.ML.Benchmarks),
[ML.NET](https://github.com/dotnet/machinelearning/tree/main/test/Microsoft.ML.PerformanceTests),
[Entity Framework Core](https://github.com/dotnet/efcore/tree/master/benchmark),
[PowerShell](https://github.com/PowerShell/PowerShell/tree/master/test/perf/benchmarks)
[SignalR](https://github.com/aspnet/SignalR/tree/master/benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks),
[F#](https://github.com/fsharp/fsharp/blob/master/tests/scripts/array-perf/array-perf.fs),
[Orleans](https://github.com/dotnet/orleans/tree/master/test/Benchmarks),
[Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json/tree/master/Src/Newtonsoft.Json.Tests/Benchmarks),
[Elasticsearch.Net](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/bool-queries.html#_perfomance_considerations),
[Dapper](https://github.com/StackExchange/Dapper/tree/master/Dapper.Tests.Performance),
[Dapper](https://github.com/DapperLib/Dapper/tree/main/benchmarks/Dapper.Tests.Performance),
[Expecto](https://github.com/haf/expecto/tree/master/Expecto.BenchmarkDotNet),
[Accord.NET](https://github.com/accord-net/framework/tree/development/Tools/Performance),
[ImageSharp](https://github.com/SixLabors/ImageSharp/tree/master/tests/ImageSharp.Benchmarks),
[RavenDB](https://github.com/ravendb/ravendb/tree/v4.0/bench),
[NodaTime](https://github.com/nodatime/nodatime/tree/master/src/NodaTime.Benchmarks),
[Jint](https://github.com/sebastienros/jint/tree/dev/Jint.Benchmark),
[NServiceBus](https://github.com/Particular/NServiceBus/issues?utf8=✓&q=+BenchmarkDotNet+),
[Serilog](https://github.com/serilog/serilog/tree/dev/test/Serilog.PerformanceTests),
[Autofac](https://github.com/autofac/Autofac/tree/develop/bench/Autofac.Benchmarks),
[Npgsql](https://github.com/npgsql/npgsql/tree/dev/test/Npgsql.Benchmarks),
[Npgsql](https://github.com/npgsql/npgsql/tree/main/test/Npgsql.Benchmarks),
[Avalonia](https://github.com/AvaloniaUI/Avalonia/tree/master/tests/Avalonia.Benchmarks),
[ReactiveUI](https://github.com/reactiveui/ReactiveUI/tree/master/src/Benchmarks),
[SharpZipLib](https://github.com/icsharpcode/SharpZipLib/tree/master/benchmark/ICSharpCode.SharpZipLib.Benchmark),
Expand All @@ -266,9 +266,9 @@ BenchmarkDotNet is already adopted by more than [4500+](https://github.com/dotne
[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
3500+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓),
2100+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and
650,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓)
4500+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓),
2500+ [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
21 changes: 11 additions & 10 deletions docs/index.md
Expand Up @@ -30,7 +30,7 @@ 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 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 [4500+ projects](#who-use-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org).
The library is adopted by [6800+ projects](#who-uses-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 @@ -110,7 +110,8 @@ The measured data can be exported to different formats (md, html, csv, xml, json

*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
*Supported OS:* Windows, Linux, macOS
*Supported architectures:* x86, x64, ARM, ARM64 and Wasm

## Features

Expand Down Expand Up @@ -231,30 +232,30 @@ If you don't customize the summary view,
## Who uses BenchmarkDotNet?

Everyone!
BenchmarkDotNet is already adopted by more than [4500+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including
BenchmarkDotNet is already adopted by more than [6800+](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),
[Mono](https://github.com/mono/mono/tree/master/sdks/wasm/bench-runner),
[ASP.NET Core](https://github.com/aspnet/AspNetCore/tree/master/src/Servers/IIS/IIS/benchmarks),
[ML.NET](https://github.com/dotnet/machinelearning/tree/master/test/Microsoft.ML.Benchmarks),
[ML.NET](https://github.com/dotnet/machinelearning/tree/main/test/Microsoft.ML.PerformanceTests),
[Entity Framework Core](https://github.com/dotnet/efcore/tree/master/benchmark),
[PowerShell](https://github.com/PowerShell/PowerShell/tree/master/test/perf/benchmarks)
[SignalR](https://github.com/aspnet/SignalR/tree/master/benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks),
[F#](https://github.com/fsharp/fsharp/blob/master/tests/scripts/array-perf/array-perf.fs),
[Orleans](https://github.com/dotnet/orleans/tree/master/test/Benchmarks),
[Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json/tree/master/Src/Newtonsoft.Json.Tests/Benchmarks),
[Elasticsearch.Net](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/bool-queries.html#_perfomance_considerations),
[Dapper](https://github.com/StackExchange/Dapper/tree/master/Dapper.Tests.Performance),
[Dapper](https://github.com/DapperLib/Dapper/tree/main/benchmarks/Dapper.Tests.Performance),
[Expecto](https://github.com/haf/expecto/tree/master/Expecto.BenchmarkDotNet),
[Accord.NET](https://github.com/accord-net/framework/tree/development/Tools/Performance),
[ImageSharp](https://github.com/SixLabors/ImageSharp/tree/master/tests/ImageSharp.Benchmarks),
[RavenDB](https://github.com/ravendb/ravendb/tree/v4.0/bench),
[NodaTime](https://github.com/nodatime/nodatime/tree/master/src/NodaTime.Benchmarks),
[Jint](https://github.com/sebastienros/jint/tree/dev/Jint.Benchmark),
[NServiceBus](https://github.com/Particular/NServiceBus/issues?utf8=✓&q=+BenchmarkDotNet+),
[Serilog](https://github.com/serilog/serilog/tree/dev/test/Serilog.PerformanceTests),
[Autofac](https://github.com/autofac/Autofac/tree/develop/bench/Autofac.Benchmarks),
[Npgsql](https://github.com/npgsql/npgsql/tree/dev/test/Npgsql.Benchmarks),
[Npgsql](https://github.com/npgsql/npgsql/tree/main/test/Npgsql.Benchmarks),
[Avalonia](https://github.com/AvaloniaUI/Avalonia/tree/master/tests/Avalonia.Benchmarks),
[ReactiveUI](https://github.com/reactiveui/ReactiveUI/tree/master/src/Benchmarks),
[SharpZipLib](https://github.com/icsharpcode/SharpZipLib/tree/master/benchmark/ICSharpCode.SharpZipLib.Benchmark),
Expand All @@ -266,9 +267,9 @@ BenchmarkDotNet is already adopted by more than [4500+](https://github.com/dotne
[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
3500+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓),
2100+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and
650,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓)
4500+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓),
2500+ [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 18e2926

Please sign in to comment.