Docs consistency

Author: CodeCasterNL

Readme.md

@@ -17,6 +17,17 @@ The following improvements are included in this library:
 Through [NuGet](https://www.nuget.org/packages/CodeCaster.WindowsServiceExtensions/):
 
     > Install-Package CodeCaster.WindowsServiceExtensions
+
+## Usage
+These methods from this package allow your `IHostedService`s to tell the Windows Service Control Manager about errors, and respond to Windows Service events relating to sessions (user logon/logoff) and power state (shutdown/hibernate/resume):
+
+* On your Host Builder, call `UseWindowsServiceExtensions()` instead of `UseWindowsService()`.
+* Instead of letting your service inherit `BackgroundService`, inherit from `CodeCaster.WindowsServiceExtensions.WindowsServiceBackgroundService`.
+* Implement `protected Task TryExecuteAsync(CancellationToken stoppingToken)` instead of `ExecuteAsync(CancellationToken stoppingToken)`.
+* Implement the method `public override bool OnPowerEvent(PowerBroadcastStatus powerStatus) { ... }` and do your thing when it's called with a certain status.
+* Implement the method `public override bool OnSessionChange(SessionChangeDescription changeDescription) { ... }` 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 reported to `OnPowerEvent()`, never neither, after a machine wake, reboot or boot.
 
 ## Documentation
 For examples and more specific documentation, see https://codecasternl.github.io/WindowsServiceExtensions/.
@@ -32,16 +43,6 @@ Changes:
 
 Extended upgrading docs: see https://codecasternl.github.io/WindowsServiceExtensions/upgrading-v2-v3.
 
-## Usage
-These methods from this package allow your `IHostedService`s to respond to Windows Service events relating to sessions (user logon/logoff) and power state (shutdown/hibernate/resume):
-
-* On your Host Builder, call `UseWindowsServiceExtensions()` instead of `UseWindowsService()`.
-* Instead of letting your service inherit `BackgroundService`, inherit from `CodeCaster.WindowsServiceExtensions.WindowsServiceBackgroundService`.
-* Implement the method `public override bool OnPowerEvent(PowerBroadcastStatus powerStatus) { ... }` and do your thing when it's called with a certain status.
-* Implement the method `public override bool OnSessionChange(SessionChangeDescription changeDescription) { ... }` 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 reported to `OnPowerEvent()`, never neither, after a machine wake, reboot or boot.
-
 # Contributing
 Please file an issue or PR. Even if you use this and are happy with it.
 

docs/index.md

@@ -16,7 +16,7 @@ Through [NuGet](https://www.nuget.org/packages/CodeCaster.WindowsServiceExtensio
     > Install-Package CodeCaster.WindowsServiceExtensions
 
 ## Why should you use this?
-Using .NET's [`UseWindowsService()`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.windowsservicelifetimehostbuilderextensions.usewindowsservice?view=dotnet-plat-ext-6.0) (from the Platform Extensions package `Microsoft.Extensions.Hosting.WindowsServices`) and [`Microsoft.Extensions.Hosting.BackgroundService`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.backgroundservice?view=dotnet-plat-ext-6.0) from `Microsoft.Extensions.Hosting.Abstractions`, a usual Windows Service program hosting some long-running background tasks could look like this:
+Using .NET's [`UseWindowsService()`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.windowsservicelifetimehostbuilderextensions.usewindowsservice?view=dotnet-plat-ext-6.0) (from the Platform Extensions package `Microsoft.Extensions.Hosting.WindowsServices`) and [`Microsoft.Extensions.Hosting.BackgroundService`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.backgroundservice?view=dotnet-plat-ext-6.0) from `Microsoft.Extensions.Hosting.Abstractions`, a typical Windows Service program hosting some long-running background tasks could look like this:
 
 ```csharp
 var hostBuilder = new HostBuilder()
@@ -112,7 +112,7 @@ public class MyCoolBackgroundService : WindowsServiceBackgroundService
     }
 
     // This one tells you when we're shutting down or resuming from semi-hibernation
-    protected override void OnPowerEvent(PowerBroadcastStatus powerStatus)
+    public override void OnPowerEvent(PowerBroadcastStatus powerStatus)
     {
         // The lifetime will log "OnPowerEvent: {powerStatus}"
 
@@ -130,7 +130,7 @@ public class MyCoolBackgroundService : WindowsServiceBackgroundService
     }
 
     // React to logon/logoff/...
-    protected override void OnSessionChange(SessionChangeDescription changeDescription)
+    public override void OnSessionChange(SessionChangeDescription changeDescription)
     {
         // The lifetime will log "OnSessionChange: {changeDescription.SessionId}, {changeDescription.Reason}"