Add mention of System.TimeProvider to README and mark ITimeProvider with obsolete attribute.

Author: RobThree

IClock.Documentation/IClock.Documentation.shfbproj

@@ -54,6 +54,8 @@
  <NamespaceSummaryItem name="IClock" isDocumented="True">&lt;para&gt;Provides interfaces and classes to work with (testable) date/times as an alternative to using &lt;see cref="P:System.DateTime.Now"&gt;DateTime.Now&lt;/see&gt; / &lt;see cref="P:System.DateTime.UtcNow"&gt;DateTime.UtcNow&lt;/see&gt;.&lt;/para&gt;</NamespaceSummaryItem>
  </NamespaceSummaries>
  <CopyrightHref>http://riii.me</CopyrightHref>
+ <TargetFrameworkVersion>v4.8</TargetFrameworkVersion>
+ <TargetFrameworkProfile />
  </PropertyGroup>
  <!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
  the build. The others are optional common platform types that may appear. -->

IClock/IClock.csproj

@@ -13,12 +13,13 @@
 <RepositoryType>Git</RepositoryType>
 <Description>Provides a testable abstraction and alternative to DateTime.Now / DateTime.UtcNow</Description>
 <PackageTags>clock datetime datetimeoffset test unittesting mock dotnet-standard datetimeprovider</PackageTags>
-<Version>1.0.1</Version>
+<Version>1.1.0</Version>
 <Configurations>Debug;Release;ReleaseWithDocumentation</Configurations>
 <LangVersion>latest</LangVersion>
 <Nullable>enable</Nullable>
 <EnableNETAnalyzers>true</EnableNETAnalyzers>
 <AnalysisLevel>latest</AnalysisLevel>
+<PackageReadmeFile>README.md</PackageReadmeFile>
 </PropertyGroup>
 
 <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
@@ -30,6 +31,10 @@
 </PropertyGroup>
 
 <ItemGroup>
+<None Include="..\README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+</None>
 <None Include="..\logo.png">
 <Pack>True</Pack>
 <PackagePath></PackagePath>

IClock/ITimeProvider.cs

@@ -1,16 +1,16 @@
 using System;
 
-namespace IClock
+namespace IClock;
+
+/// <summary>
+/// Defines a method to get (date)time.
+/// </summary>
+[Obsolete("Use System.TimeProvider instead (https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider)")]
+public interface ITimeProvider
 {
  /// <summary>
- /// Defines a method to get (date)time.
+ /// Returns the providers' (date)time.
  /// </summary>
- public interface ITimeProvider
- {
- /// <summary>
- /// Returns the providers' (date)time.
- /// </summary>
- /// <returns>The providers' (date)time.</returns>
- DateTimeOffset GetTime();
- }
+ /// <returns>The providers' (date)time.</returns>
+ DateTimeOffset GetTime();
 }

README.md

@@ -1,8 +1,12 @@
-# <img src="https://raw.githubusercontent.com/RobThree/IClock/master/logo.png" alt="Logo" width="32" height="32"> IClock
+# <img src="https://raw.githubusercontent.com/RobThree/IClock/master/logo.png" alt="Logo" width="32" height="32"> IClock
 Provides a testable abstraction and alternative to `DateTime.Now` / `DateTime.UtcNow` and `DateTimeOffset.Now` / `DateTimeOffset.UtcNow`. Targets netstandard1.0 and higher.
 
 [![Build status](https://ci.appveyor.com/api/projects/status/cfocayl8qvi3d8cl)](https://ci.appveyor.com/project/RobIII/iclock) <a href="https://www.nuget.org/packages/IClock/"><img src="http://img.shields.io/nuget/v/IClock.svg?style=flat-square" alt="NuGet version" height="18"></a>
 
+## First: Good news! 🎉
+
+As of the release of .Net 8 (nov. 14th 2023) Microsoft provides the [TimeProvider class](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider) and [ITimer interface](https://learn.microsoft.com/en-us/dotnet/api/system.threading.itimer). A good primer on this topic is over at [Andrew Lock's site](https://andrewlock.net/exploring-the-dotnet-8-preview-avoiding-flaky-tests-with-timeprovider-and-itimer/) ([archived version](https://archive.is/5bZU7)). You may want to check that out before continuing. What that means for IClock? It'll most likely be the end of this library, but that's a good thing. I'll keep supporting it for a while but switching to the Microsoft provided solution shouldn't be hard.
+
 ## Why and how
 
 When writing and testing (date)time-related code it is tempting to use any of the `DateTime.Now`, `DateTime.UtcNow`, `DateTimeOffset.Now` or `DateTimeOffset.UtcNow` properties. This, however, causes problems during (unit)testing. It makes your tests dependent on when your tests are run. This means your tests could pass on tuesdays and, without any changes, fail on wednesdays. Or only fail during nighttime or at any other time.