Merge pull request #2 from Shuttle/v21

V21

Author: eben-roux

README.md

@@ -1,46 +1,64 @@
 # Shuttle.Core.System
 
+OS and system level abstractions that provide a way to decouple your logic from static system calls, making your code more testable.
+
+## Why?
+
+When your code calls `DateTimeOffset.UtcNow`, `Environment.UserInteractive`, or `Process.GetCurrentProcess()`, it is difficult to unit test that code because these are static calls to the operating system. By using these abstractions, you can mock the system-level behavior in your tests.
+
+## Installation
+
+```bash
+dotnet add package Shuttle.Core.System
 ```
-PM> Install-Package Shuttle.Core.System
+
+## Usage
+
+Register the services with your dependency injection container:
+
+```csharp
+services.AddSingleton<ISystemClock, SystemClock>();
+services.AddSingleton<IEnvironmentService, EnvironmentService>();
+services.AddSingleton<IProcessService, ProcessService>();
 ```
 
-OS and system level abstractions.
+All types are in the `Shuttle.Core.System` namespace.
 
-## ISystemClock
+## `ISystemClock`
 
 The default implementation is `SystemClock`.
 
-``` c#
+```csharp
 DateTimeOffset UtcNow { get; }
 ```
 
-Return the `DataTimeOffset` as the current UTC data/time.
+Returns the `DateTimeOffset` representing the current UTC date/time.
 
-## IEnvironmentService
+## `IEnvironmentService`
 
 The default implementation is `EnvironmentService`.
 
-``` c#
+```csharp
 bool UserInteractive { get; }
 ```
 
-Return `true` if running as a console application; else `false`.
+Returns `true` if running as a console application; otherwise `false`.
 
-## IProcessService
+## `IProcessService`
 
 The default implementation is `ProcessService`.
 
-``` c#
+```csharp
 IProcess GetCurrentProcess();
 ```
 
- Returns the `IProcess` abstraction for the current process.
+Returns an `IProcess` abstraction for the current system process.
 
-## IProcess
+## `IProcess`
 
-Represents a system process and the default implementation is `SystemProcess`.
+Represents a system process. The default implementation is `SystemProcess`.
 
-``` c#
+```csharp
 void Kill();
 ```