Update documentation (#65)

* Update docs/readme

Author: wdolek

README.md

@@ -27,22 +27,17 @@ Distributed tracing and trace context is built in .NET, You can get more insight
 ### Startup class
 
 ```csharp
-public class MyLittleStartup
-{
-    public void ConfigureServices(IServiceCollection services)
-    {
-        services.AddDefaultCorrelator();
-    }
+var builder = WebApplication.CreateBuilder(args);
+builder.Services.AddDefaultCorrelator();
 
-    public void Configure(IApplicationBuilder app)
-    {
-        // register as first middleware
-        // (or as soon as possible to benefit from having correlation ID)
-        app.UseCorrelator();
+var app = builder.Build();
 
-        app.UseMvc();
-    }
-}
+// register as first middleware
+// (or as soon as possible to benefit from having correlation ID)
+app.UseCorrelator();
+
+// ...
+app.Run();
 ```
 
 ### Accessing correlation ID
@@ -78,34 +73,28 @@ In order to pass correlation ID to subsequent requests, additional HTTP message
 Add `CorrelatorHttpMessageHandler` to HTTP client's message handler pipeline like this:
 
 ```csharp
-public class MyLittleStartup
-{
-    public void ConfigureServices(IServiceCollection services)
-    {
-        // named HTTP client
-        services
-            .AddHttpClient("DummyClient")
-            .WithCorrelation();
-
-        // typed HTTP client
-        services
-            .AddHttpClient<FooClient>()
-            .WithCorrelation();
-
-        // registering HTTP message handler manually
-        services
-            .AddHttpClient("FizzClient")
-            .AddHttpMessageHandler<CorrelatorHttpMessageHandler>();
-
-        // registering HTTP client with custom settings
-        // (global options - CorrelatorOptions.Forward - won't be used)
-        services
-            .AddHttpClient<LegacyClient>()
-            .WithCorrelation(PropagationSettings.PropagateAs("X-Legacy-Correlation-Id"));
-    }
-
-    // ...
-}
+// named HTTP client
+builder.Services
+    .AddHttpClient("DummyClient")
+    .WithCorrelation();
+
+// typed HTTP client
+builder.Services
+    .AddHttpClient<FooClient>()
+    .WithCorrelation();
+
+// registering HTTP message handler manually
+builder.Services
+    .AddHttpClient("FizzClient")
+    .AddHttpMessageHandler<CorrelatorHttpMessageHandler>();
+
+// registering HTTP client with custom settings
+// (global options - CorrelatorOptions.Forward - won't be used)
+builder.Services
+    .AddHttpClient<LegacyClient>()
+    .WithCorrelation(PropagationSettings.PropagateAs("X-Legacy-Correlation-Id"));
+
+// ...
 ```
 
 See "[Configure the HttpMessageHandler](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/http-requests?view=aspnetcore-2.1#configure-the-httpmessagehandler)" for more details about usage of HTTP message handler.
@@ -118,13 +107,10 @@ turned off. In order to turn validation on, implementation of `ICorrelationValid
 Correlator is shipped with lightweight validator, `CorrelationValueLengthValidator`, which decides whether received
 value is valid simply based on its length.
 
-```
-public void ConfigureServices(IServiceCollection services)
-{
-    services
-        .AddDefaultCorrelator()
-        .WithValidator(new CorrelationValueLengthValidator(64));
-}
+```csharp
+builder.Services
+    .AddDefaultCorrelator()
+    .WithValidator(new CorrelationValueLengthValidator(64));
 ```
 
 ## Documentation

docs/configuration.md

@@ -17,7 +17,7 @@ By _default_, Correlator is configured following way:
 To adjust setting, use `AddDefaultCorrelator` or `AddCorrelator` overload:
 
 ```csharp
-services.AddDefaultCorrelator(
+builder.Services.AddDefaultCorrelator(
     correlatorOptions =>
     {
         // disable correlation ID factory

docs/registration.md

@@ -4,49 +4,43 @@ Apart of registering default implementations of `ICorrelationContextFactory` and
 also provide own implementation.
 
 ```csharp
-public class MyLittleStartup
-{
-    public void ConfigureServices(IServiceCollection services)
-    {
-        services
-            .AddCorrelator()
-            .WithCorrelationContextFactory<MyLittleCorrelationContextFactory>()
-            .WithCorrelationEmitter<MyLittleCorrelationEmitter>();
-    }
-
-    // ...
-}
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services
+    .AddCorrelator()
+    .WithCorrelationContextFactory<MyLittleCorrelationContextFactory>()
+    .WithCorrelationEmitter<MyLittleCorrelationEmitter>();
 ```
 
 ### Simple registration
 
-```
-services.AddDefaultCorrelator();
+```csharp
+builder.Services.AddDefaultCorrelator();
 
 // or
-services.AddDefaultCorrelator(options => { /* */ });
+builder.Services.AddDefaultCorrelator(options => { /* */ });
 ```
 
 ### Custom registration
 
-```
-ICorrelatorBuilder builder = services.AddCorrelator();
+```csharp
+ICorrelatorBuilder correlationBuilder = builder.Services.AddCorrelator();
 
 // or
-ICorrelatorBuilder builder = services.AddCorrelator(options => { /* */ });
+ICorrelatorBuilder correlationBuilder = builder.Services.AddCorrelator(options => { /* */ });
 ```
 
 ... and then either of:
-```
+```csharp
 // correlation context factory
-builder.WithDefaultCorrelationContextFactory(); // default implementation
-builder.WithCorrelationContextFactory<T>(); // type registration
-builder.WithCorrelationContextFactory(T factory); // instance registration
+correlationBuilder.WithDefaultCorrelationContextFactory(); // default implementation
+correlationBuilder.WithCorrelationContextFactory<T>(); // type registration
+correlationBuilder.WithCorrelationContextFactory(T factory); // instance registration
 
 // correlation emitter
-builder.WithDefaultCorrelationEmitter(); // default implementation
-builder.WithCorrelationEmitter<T>(); // type registration
-builder.WithCorrelationEmitter(T emitter); // instance registration
+correlationBuilder.WithDefaultCorrelationEmitter(); // default implementation
+correlationBuilder.WithCorrelationEmitter<T>(); // type registration
+correlationBuilder.WithCorrelationEmitter(T emitter); // instance registration
 ```
 
 Both `ICorrelationContextFactory` and `ICorrelationEmitter` are registered as singletons.
@@ -58,8 +52,8 @@ end up with exception.
 
 Optionally, you can register correlation validator like this (by default, no validator is registered):
 
-```
-builder.WithValidator(new CorrelationValueLengthValidator(64));
+```csharp
+correlationBuilder.WithValidator(new CorrelationValueLengthValidator(64));
 ```
 
 `ICorrelationValidator` is registered as singleton.

run-bench-cmp.bat

@@ -1 +1 @@
-dotnet build -c:Release && dotnet run -c:Release --project benchmarks/W4k.AspNetCore.Correlator.Benchmarks/ -- -f W4k.AspNetCore.Correlator.Benchmarks.Comparing* --join --allStats
+dotnet build -c:Release && dotnet run -c:Release -f net9.0 --project benchmarks/W4k.AspNetCore.Correlator.Benchmarks/ -- -f W4k.AspNetCore.Correlator.Benchmarks.Comparing* --join --allStats

run-bench.bat

@@ -1 +1 @@
-dotnet build -c:Release && dotnet run -c:Release --project benchmarks/W4k.AspNetCore.Correlator.Benchmarks/ -- -f W4k.AspNetCore.Correlator.Benchmarks.Request* --join --allStats
+dotnet build -c:Release && dotnet run -c:Release -f net9.0 --project benchmarks/W4k.AspNetCore.Correlator.Benchmarks/ -- -f W4k.AspNetCore.Correlator.Benchmarks.Request* --join --allStats