docs: update docs and move select parts into nuget description

Author: egil

CHANGELOG.md

@@ -11,19 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Allow `ManualTimeProvider.Start` to be set using property initializers.
 
-- Made the timer type created by `ManualTimeProvider`, the `ManualTimer` type, public, and introduced a protected method `CreateManualTimer` on `ManualTimeProvider`. This enables advanced scenarioes where a custom `ManualTimer` is needed. 
+- Made the timer type created by `ManualTimeProvider`, the `ManualTimer` type, public, and introduced a protected method `CreateManualTimer` on `ManualTimeProvider`. This enables advanced scenarios where a custom `ManualTimer` is needed.
 
   A custom implementation of `ManualTimer` can override the `Change` method and add custom behavior to it.
 
   Overriding `CreateManualTimer` makes it possible to intercept a `TimerCallback` and perform actions before and after the timer callback has been invoked.
 
-- Replace `AutoAdvanceAmount` property with the `AutoAdvanceBehavior` property on `ManualTimeProvider`, and introduced the `AutoAdvanceBehavior` type. To automatically advance time when `GetUtcNow()` or `GetLocalNow()` is called, set `AutoAdvanceBehavior.UtcNowAdvanceAmount` to a time span larger than zero.
+- Replace the `AutoAdvanceAmount` property with the `AutoAdvanceBehavior` property on `ManualTimeProvider`, and introduce the `AutoAdvanceBehavior` type. To automatically advance the time when `GetUtcNow()` or `GetLocalNow()` is called, set `AutoAdvanceBehavior.UtcNowAdvanceAmount` to a `TimeSpan` larger than zero.
 
-- Enable auto advance feature for `GetTimestamp()` and `GetElapsedTime(long)`. To automatically advance time when `GetTimestamp()` or `GetElapsedTime(long)` is called, set `AutoAdvanceBehavior.TimestampAdvanceAmount` to a time span larger than zero.
+- Enable auto advance feature for `GetTimestamp()` and `GetElapsedTime(long)`. To automatically advance the time when `GetTimestamp()` or `GetElapsedTime(long)` is called, set `AutoAdvanceBehavior.TimestampAdvanceAmount` to a `TimeSpan` larger than zero.
 
 - `ManualTimer` now exposes its current configuration. `DueTime`, `Period`, `IsActive`, `CallbackTime`, and `CallbackInvokeCount` are now publicly visible.
 
-- Enable auto advance feature for timers. This enables automatically calling timers callback a specified number of times, by setting the `AutoAdvanceBehavior.TimerAutoTriggerCount` property to a number larger than zero.
+- Enable auto-advance feature for timers. This enables automatically calling timers callback a specified number of times, by setting the `AutoAdvanceBehavior.TimerAutoTriggerCount` property to a number larger than zero.
 
 ## [1.0.0-rc.1]
 
@@ -51,9 +51,9 @@ Aligned the public API surface of `ManualTimeProvider` with `Microsoft.Extension
 
 ## [1.0.0-preview.3]
 
-- Changed `ManualTestProvider` sets the local time zone to UTC by default, provides method for overriding during testing.
+- Changed `ManualTestProvider` to set the local time zone to UTC by default, providing a method for overriding during testing.
 
-- Changed `ManualTestProvider.ToString()` method to return current date time.
+- Changed the `ManualTestProvider.ToString()` method to return current date time.
 
 - Fixed `ITimer` returned by `ManualTestProvider` such that timers created with a due time equal to zero will fire the timer callback immediately.
 
@@ -63,9 +63,9 @@ This release adds a dependency on [Microsoft.Bcl.TimeProvider](https://www.nuget
 
 When using the `ManualTimeProvider` during testing, be aware of these outstanding issues: https://github.com/dotnet/runtime/issues/85326
 
-- Removed `CancelAfter` extension methods. Instead create a CancellationTokenSource via the method `TimeProvider.CreateCancellationTokenSource(TimeSpan delay)` or in .NET 8, using `new CancellationTokenSource(TimeSpan delay, TimeProvider timeProvider). 
+- Removed `CancelAfter` extension methods. Instead, create a CancellationTokenSource via the method `TimeProvider.CreateCancellationTokenSource(TimeSpan delay)` or in .NET 8, using `new CancellationTokenSource(TimeSpan delay, TimeProvider timeProvider).
 
-  **NOTE:** If running on .NET versions earlier than .NET 8.0, there is a constraint when invoking `CancellationTokenSource.CancelAfter(TimeSpan)` on the resultant object. This action will not terminate the initial timer indicated by `delay`. However, this restriction does not apply on .NET 8.0 and later versions.
+  **NOTE:** If running on .NET versions earlier than .NET 8.0, there is a constraint when invoking `CancellationTokenSource.CancelAfter(TimeSpan)` on the resultant object. This action will not terminate the initial timer indicated by `delay`. However, this restriction does not apply to .NET 8.0 and later versions.
 
 ## [0.8.0]
 
@@ -80,7 +80,7 @@ When using the `ManualTimeProvider` during testing, be aware of these outstandin
 
 - Changed `TestTimeProvider` to `ManualTimeProvider`.
 - `ManualTimeProvider` no longer implements on `IDisposable`.
-- Moving time forward using `ManualTimeProvider` will now move time forward in steps, stopping at each scheduled timer/callback time, set the internal "UtcNow" clock returned from `GetUtcNow()` invoke the callback, and then progress to the next scheduled timer, until the target "UtcNow" is reached.
+- Moving time forward using `ManualTimeProvider` will now move time forward in steps, stopping at each scheduled timer/callback time, setting the internal "UtcNow" clock returned from `GetUtcNow()` to invoke the callback, and then progress to the next scheduled timer, until the target "UtcNow" is reached.
 
 ## [0.5.0]
 
@@ -96,8 +96,8 @@ When using the `ManualTimeProvider` during testing, be aware of these outstandin
 
 ### Added
 
-- Adds support for cancelling a `CancellationTokenSource` after a specific timespan via the `ITimeScheduler.CancelAfter(CancellationTokenSource, TimeSpan)` method.
-- Adds an singleton instance property to `DefaultScheduler` that can be used instead of creating a new instance for every use.
+- Adds support for canceling a `CancellationTokenSource` after a specific timespan via the `ITimeScheduler.CancelAfter(CancellationTokenSource, TimeSpan)` method.
+- Adds a singleton instance property to `DefaultScheduler` that can be used instead of creating a new instance for every use.
 
 ### Changed
 
@@ -106,7 +106,7 @@ When using the `ManualTimeProvider` during testing, be aware of these outstandin
 
 ## [0.2.0] - 2023-02-21
 
-Adds support for `Task.WaitAsync` family of methods.
+Adds support for the `Task.WaitAsync` family of methods.
 
 ## [0.1.3-preview] - 2023-01-30
 

README.md

@@ -4,9 +4,9 @@
 
 # TimeProvider Extensions
 
-Extensions for the [`System.TimeProvider`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider) API. It includes:
+Testing extensions for the [`System.TimeProvider`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider) API. It includes:
 
-- A test/fake version of `TimeProvider` type, named `ManualTimeProvider`, that allows you to control the progress of time during testing deterministically.
+- An advanced test/fake version of the `TimeProvider` type, named `ManualTimeProvider`, that allows you to control the progress of time during testing deterministically (see the difference to Microsoft's `FakeTimeProvider` below).
 - A backported version of `PeriodicTimer` that supports `TimeProvider` in .NET 6.
 
 ## Quick start
@@ -15,21 +15,23 @@ This describes how to get started:
 
 1. Get the latest release from https://www.nuget.org/packages/TimeProviderExtensions.
 
-2. Take a dependency on `TimeProvider` in your code. Inject the production version of `TimeProvider` available via the [`TimeProvider.System`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider.system?#system-timeprovider-system) property during production.
+2. Take a dependency on `TimeProvider` in your production code. Inject the production version of `TimeProvider` available via the [`TimeProvider.System`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider.system?#system-timeprovider-system) property during production.
 
 3. During testing, inject the `ManualTimeProvider` from this library. This allows you to write tests that run fast and predictably.
    - Advance time by calling `Advance(TimeSpan)` or `SetUtcNow(DateTimeOffset)` or
-   - Jump ahead in time using `Jump(TimeSpan)` or `Jump(DateTimeOffset)`     
+   - Jump ahead in time using `Jump(TimeSpan)` or `Jump(DateTimeOffset)`.
 
 4. See the **[`ManualTimeProvider API`](https://github.com/egil/TimeProviderExtensions/blob/main/docs/TimeProviderExtensions.ManualTimeProvider.md) page** for the full API documentation for `ManualTimeProvider`.
 
 5. Read the rest of this README for further details and examples.
 
 ## API Overview
 
-These pages has all the details of the API included in this package:
+These pages have all the details of the API included in this package:
 
 - [`ManualTimeProvider`](https://github.com/egil/TimeProviderExtensions/blob/main/docs/TimeProviderExtensions.ManualTimeProvider.md)
+- [`AutoAdvanceBehavior`](https://github.com/egil/TimeProviderExtensions/blob/main/docs/TimeProviderExtensions.AutoAdvanceBehavior.md)
+- [`ManualTimer`](https://github.com/egil/TimeProviderExtensions/blob/main/docs/TimeProviderExtensions.ManualTimer.md)
 
 **.NET 7 and earlier:**
 
@@ -40,10 +42,11 @@ These pages has all the details of the API included in this package:
 
 - If running on .NET versions earlier than .NET 8.0, there is a constraint when invoking `CancellationTokenSource.CancelAfter(TimeSpan)` on the `CancellationTokenSource` object returned by `CreateCancellationTokenSource(TimeSpan delay)`. This action will not terminate the initial timer indicated by the `delay` argument initially passed the `CreateCancellationTokenSource` method. However, this restriction does not apply to .NET 8.0 and later versions.
 - To enable controlling `PeriodicTimer` via `TimeProvider` in versions of .NET earlier than .NET 8.0, the `TimeProvider.CreatePeriodicTimer` returns a `PeriodicTimerWrapper` object instead of a `PeriodicTimer` object. The `PeriodicTimerWrapper` type is just a lightweight wrapper around the original `System.Threading.PeriodicTimer` and will behave identically to it.
-- If `ManualTimeProvider` is created via [AutoFixture](https://github.com/AutoFixture/AutoFixture), be aware that will set `AutoAdvanceAmount` to a random positive time span. This behavior can be overridden by providing a customization to AutoFixture, e.g.:  
+- If `ManualTimeProvider` is created via [AutoFixture](https://github.com/AutoFixture/AutoFixture), be aware that will set writable properties with random values. This behavior can be overridden by providing a customization to AutoFixture, e.g.:
   ```c#
-  fixture.Customize<ManualTimeProvider>(x => x.With(tp => tp.AutoAdvanceAmount, TimeSpan.Zero));
+  fixture.Customize<ManualTimeProvider>(x => x.OmitAutoProperties()));
   ```
+  or by using the `[NoAutoProperties]` attribute, if using `AutoFixture.Xunit2`.
 
 ## Installation and Usage
 
@@ -52,7 +55,7 @@ Get the latest release from https://www.nuget.org/packages/TimeProviderExtension
 ### Set up in production
 
 To use in production, pass in `TimeProvider.System` to the types that depend on `TimeProvider`.
-This can be done directly or via an IoC Container, e.g. .NETs built-in `IServiceCollection` like so:
+This can be done directly or via an IoC Container, e.g., .NETs built-in `IServiceCollection` like so:
 
 ```c#
 services.AddSingleton(TimeProvider.System);

src/TimeProviderExtensions/TimeProviderExtensions.csproj

@@ -6,14 +6,32 @@
 		<Company>Egil Hansen</Company>
 		<Authors>Egil Hansen</Authors>
 		<Description>
-			Extensions for the `System.TimeProvider` API. It includes a test version of the `TimeProvider`, named `ManualTimeProvider`,
-			that allows you to control the progress of time during testing deterministically and a backport of the `PeriodicTimer`
-			version from .NET 8 to .NET 6/7 that supports `TimeProvider`.
+# TimeProvider Extensions
+
+Testing extensions for the [`System.TimeProvider`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider) API. It includes:
+
+- An advanced test/fake version of the `TimeProvider` type, named `ManualTimeProvider`, that allows you to control the progress of time during testing deterministically (see the difference to Microsoft's `FakeTimeProvider` below).
+- A backported version of `PeriodicTimer` that supports `TimeProvider` in .NET 6.
+
+## Quick start
+
+This describes how to get started:
+
+1. Get the latest release from https://www.nuget.org/packages/TimeProviderExtensions.
+
+2. Take a dependency on `TimeProvider` in your production code. Inject the production version of `TimeProvider` available via the [`TimeProvider.System`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider.system?#system-timeprovider-system) property during production.
+
+3. During testing, inject the `ManualTimeProvider` from this library. This allows you to write tests that run fast and predictably.
+   - Advance time by calling `Advance(TimeSpan)` or `SetUtcNow(DateTimeOffset)` or
+   - Jump ahead in time using `Jump(TimeSpan)` or `Jump(DateTimeOffset)`.
+
+4. See the **[`ManualTimeProvider API`](https://github.com/egil/TimeProviderExtensions/blob/main/docs/TimeProviderExtensions.ManualTimeProvider.md) page** for the full API documentation for `ManualTimeProvider`.
+
+5. Read the [README](https://github.com/egil/TimeProviderExtensions) for further details and examples.
 		</Description>
 		<PackageTags>TimeProvider, testing</PackageTags>
 		<Copyright>Egil Hansen</Copyright>
 		<PackageProjectUrl>https://github.com/egil/TimeProviderExtensions</PackageProjectUrl>
-		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<RepositoryUrl>https://github.com/egil/TimeProviderExtensions</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
 		<PackageLicenseFile>LICENSE</PackageLicenseFile>
@@ -73,10 +91,6 @@
 			<Pack>True</Pack>
 			<PackagePath>\</PackagePath>
 		</None>
-		<None Include="..\..\README.md">
-			<Pack>True</Pack>
-			<PackagePath>\</PackagePath>
-		</None>
 	</ItemGroup>
 
 	<ItemGroup>