More docs

Author: CodeCasterNL

Readme.md

@@ -1,12 +1,18 @@
 # WindowsServiceExtensions
-Make a .NET Core Windows Service that runs `IHostedService` background services power event aware.
+Make a .NET Core Windows Service that runs `IHostedService` background services power event aware. On consumer OS Windows 10, shutting down the computer will actually hibernate the OS. Services won't get another OnStart call.
 
-On consumer OS Windows 10, shutting down the computer will actually hibernate the OS. Services won't get another OnStart call.
+This project exists of a few classes that make building reliable Windows Services easier. The Lifetime class also include [kmcclellan's fixes](https://github.com/dotnet/runtime/issues/50019#issuecomment-678658133) that make the service throw when something fails on startup, instead of reprorting it started successfully.
 
-These extensions allow your IHostedServices to respond to this power state change:
+## Installation
+Through [NuGet](https://www.nuget.org/packages/CodeCaster.WindowsServiceExtensions/):
+
+    > Install-Package CodeCaster.WindowsServiceExtensions
+
+## Usage
+These extensions allow your IHostedServices to respond to this power state change.:
 
 * On your Host Builder, call `UsePowerEventAwareWindowsService()` instead of [`UseWindowsService()`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.windowsservicelifetimehostbuilderextensions.usewindowsservice?view=dotnet-plat-ext-3.1).
 * Instead of letting your service inherit [`Microsoft.Extensions.Hosting.BackgroundService`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.backgroundservice?view=dotnet-plat-ext-5.0), inherit from `CodeCaster.WindowsServiceExtensions.PowerEventAwareBackgroundService`.
-* Implement the method `public override bool OnPowerEvent(PowerBroadcastStatus powerStatus)`
+* Implement the method `public override bool OnPowerEvent(PowerBroadcastStatus powerStatus)` and do your thing when it's called with a certain status.
 
 Do note that the statuses received can vary. You get either `ResumeSuspend`, `ResumeAutomatic` or both, never neither, after a machine wake, reboot or boot. 

src/CodeCaster.WindowsServiceExtensions/PowerEventAwareWindowsServiceLifetime.cs

@@ -25,6 +25,7 @@ public class PowerEventAwareWindowsServiceLifetime : WindowsServiceLifetime, IHo
         private readonly IHostApplicationLifetime _applicationLifetime;
         private IReadOnlyCollection<IPowerEventAwareHostedService>? _hostedServices;
 
+        /// <inheritdoc />
         public PowerEventAwareWindowsServiceLifetime(IServiceProvider serviceProvider, IHostEnvironment environment, IHostApplicationLifetime applicationLifetime, ILoggerFactory loggerFactory, IOptions<HostOptions> optionsAccessor)
             : base(environment, applicationLifetime, loggerFactory, optionsAccessor)
         {
@@ -38,6 +39,7 @@ public PowerEventAwareWindowsServiceLifetime(IServiceProvider serviceProvider, I
             }
         }
 
+        /// <inheritdoc />
         public new async Task WaitForStartAsync(CancellationToken cancellationToken)
         {
             _logger.LogInformation("Windows Service start requested");
@@ -88,6 +90,7 @@ protected override bool OnPowerEvent(PowerBroadcastStatus powerStatus)
             return true;
         }
 
+        /// <inheritdoc />
         protected override void OnStart(string[] args)
         {
             _logger.LogInformation("Windows Service OnStart() was called");