Code comments, readme, and docs updates

Author: daveaglick

Diff for: README.md

@@ -1,7 +1,22 @@
-# MsBuildPipeLogger
-
 A logger for MSBuild that sends event data over anonymous or named pipes.
 
+**NuGet**
+* [MsBuildPipeLogger.Logger](https://www.nuget.org/packages/MsBuildPipeLogger.Logger/)
+* [MsBuildPipeLogger.Server](https://www.nuget.org/packages/MsBuildPipeLogger.Server/)
+
+**MyGet**
+* [MsBuildPipeLogger.Logger](https://www.myget.org/feed/msbuildpipelogger/package/nuget/MsBuildPipeLogger.Logger)
+* [MsBuildPipeLogger.Server](https://www.myget.org/feed/msbuildpipelogger/package/nuget/MsBuildPipeLogger.Server)
+
+**GitHub**
+* [MsBuildPipeLogger](https://github.com/daveaglick/MsBuildPipeLogger)
+
+**Donations**
+
+<a href="https://www.buymeacoffee.com/daveaglick"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+
+---
+
 ## Say what?
 
 As a general purpose build tool, MSBuild is really powerful. However, it can be hard to figure out what's going on under the hood. Thankfully, MSBuild provides a nice logging API that consists of sending a sequence of events to one or more attached loggers. This allows the logger to track (almost) everything that happens during the build.
@@ -14,6 +29,10 @@ I wrote this to address a need I had in [Buildalyzer](https://github.com/daveagl
 
 ## How do I use it?
 
+There are two libraries:
+* [MsBuildPipeLogger.Logger](https://www.nuget.org/packages/MsBuildPipeLogger.Logger/) - the logger that's given to MSBuild.
+* [MsBuildPipeLogger.Server](https://www.nuget.org/packages/MsBuildPipeLogger.Server/) - the server that receives logging events from the pipe and raises them to your code.
+
 Usage consists of creating a server to receive logging events and then telling MSBuild to use the `MsBuildPipeLogger`. It's slightly different depending on if you want to use an [anonymous pipe](https://docs.microsoft.com/en-us/dotnet/standard/io/how-to-use-anonymous-pipes-for-local-interprocess-communication) or a [named pipe](https://docs.microsoft.com/en-us/dotnet/standard/io/how-to-use-named-pipes-for-network-interprocess-communication).
 
 ### Anonymous pipe
@@ -85,5 +104,7 @@ The `MsBuildPipeLogger.Logger` recognizes these parameters, separated by a `;` a
 * `name` indicates the named pipe name: `MsBuildPipeLogger.Logger,MsBuildPipeLogger.Logger.dll;name=Mario`
 * `server` indicates the named pipe server (assumed to be a local pipe if omitted): `MsBuildPipeLogger.Logger,MsBuildPipeLogger.Logger.dll;name=Mario;server=MyServerName`
 
----
-This project is maintained by Dave Glick ([@daveaglick](https://github.com/daveaglick))
+### A note on concurrency
+
+The `AnonymousPipeLoggerServer.Read()` and `NamedPipeLoggerServer.Read()` methods both block while waiting for additional events. If you need to support concurrency or cancellation, you'll need to wrap this call however is appropriate for your application.
+

Diff for: docs/input/_Footer.cshtml

@@ -0,0 +1 @@
+MsBuildPipeLogger is crafted by <a href="https://daveaglick.com">Dave Glick</a>. <a href="https://github.com/daveaglick/MsBuildPipeLogger">Code on GitHub</a>. Generated by <a href="https://wyam.io">Wyam</a> and hosted by <a href="https://www.netlify.com">Netlify</a> on a free open source plan.

Diff for: docs/input/_Navbar.cshtml

@@ -0,0 +1,3 @@
+<li><a href="@(Context.GetLink("api"))">API</a></li>
+<li><a href="https://github.com/daveaglick/MsBuildPipeLogger">GitHub</a></li>
+<li class="buymeacoffee"><a href="https://www.buymeacoffee.com/daveaglick"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee"></a></li>

Diff for: docs/input/assets/css/override.less

@@ -0,0 +1,21 @@
+@import "bootstrap/variables.less";
+@import "bootstrap/mixins.less";
+@import "adminlte/variables.less";
+@import "adminlte/mixins.less";
+
+@media (min-width: 768px) { 
+	.buymeacoffee {
+        position: absolute !important;
+        right: 0 !important;
+        top: -8px !important;
+
+        & a {
+            height: 58px !important;
+
+            & img {
+                height: auto !important;
+                width: auto !important;
+            }
+        }
+    }
+}

Diff for: docs/input/index.md

@@ -1,3 +1,4 @@
-Title: MsBuildPipeLogger
+Title: Home
+NoTitle: true
 ---
 ^"../../README.md"

Diff for: src/MsBuildPipeLogger.Logger/MsBuildPipeLogger.Logger.csproj

@@ -3,6 +3,13 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard1.3</TargetFrameworks>
     <RootNamespace>MsBuildPipeLogger</RootNamespace>
+    <Authors>Dave Glick</Authors>
+    <Company>Dave Glick</Company>
+    <Product />
+    <Description>A logger for MSBuild that sends event data over anonymous or named pipes.</Description>
+    <PackageProjectUrl>https://msbuildpipelogger.netlify.com/</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/daveaglick/MsBuildPipeLogger.git</RepositoryUrl>
+    <PackageLicenseUrl>https://github.com/daveaglick/MsBuildPipeLogger/blob/master/LICENSE</PackageLicenseUrl>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Build" Version="14.3.0" PrivateAssets="All" />

Diff for: src/MsBuildPipeLogger.Server/AnonymousPipeLoggerServer.cs

@@ -3,18 +3,30 @@
 
 namespace MsBuildPipeLogger
 {
+    /// <summary>
+    /// An server for receiving MSBuild logging events over an anonymous pipe.
+    /// </summary>
     public class AnonymousPipeLoggerServer : PipeLoggerServer
     {
         private string _clientHandle;
 
+        /// <summary>
+        /// Creates an anonymous pipe server for receiving MSBuild logging events.
+        /// </summary>
         public AnonymousPipeLoggerServer()
             : base(new AnonymousPipeServerStream(PipeDirection.In, HandleInheritability.Inheritable))
         {
         }
 
+        /// <summary>
+        /// Gets the client handle as a string. The local copy of the handle will be automatically disposed
+        /// on the first call to <see cref="Read"/>.
+        /// </summary>
+        /// <returns>The client handle as a string.</returns>
         public string GetClientHandle() =>
             _clientHandle ?? (_clientHandle = ((AnonymousPipeServerStream)PipeStream).GetClientHandleAsString());
 
+        /// <inheritdoc/>
         public override bool Read()
         {
             // First dispose the client handle if we asked for one

Diff for: src/MsBuildPipeLogger.Server/MsBuildPipeLogger.Server.csproj

@@ -3,6 +3,13 @@
   <PropertyGroup>
     <TargetFramework>netstandard1.5</TargetFramework>
     <RootNamespace>MsBuildPipeLogger</RootNamespace>
+    <Authors>Dave Glick</Authors>
+    <Company>Dave Glick</Company>
+    <Product />
+    <Description>A logger for MSBuild that sends event data over anonymous or named pipes.</Description>
+    <PackageProjectUrl>https://msbuildpipelogger.netlify.com/</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/daveaglick/MsBuildPipeLogger.git</RepositoryUrl>
+    <PackageLicenseUrl>https://github.com/daveaglick/MsBuildPipeLogger/blob/master/LICENSE</PackageLicenseUrl>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Build" Version="15.3.409" />

Diff for: src/MsBuildPipeLogger.Server/NamedPipeLoggerServer.cs

@@ -2,15 +2,23 @@
 
 namespace MsBuildPipeLogger
 {
+    /// <summary>
+    /// An server for receiving MSBuild logging events over a named pipe.
+    /// </summary>
     public class NamedPipeLoggerServer : PipeLoggerServer
     {
         private bool _connected;
 
+        /// <summary>
+        /// Creates a named pipe server for receiving MSBuild logging events.
+        /// </summary>
+        /// <param name="pipeName">The name of the pipe to create.</param>
         public NamedPipeLoggerServer(string pipeName)
             : base(new NamedPipeServerStream(pipeName, PipeDirection.In))
         {
         }
 
+        /// <inheritdoc />
         public override bool Read()
         {
             if (!_connected)

Diff for: src/MsBuildPipeLogger.Server/PipeLoggerServer.cs

@@ -9,6 +9,10 @@
 
 namespace MsBuildPipeLogger
 {
+    /// <summary>
+    /// Receives MSBuild logging events over a pipe. This is the base class for <see cref="AnonymousPipeLoggerServer"/>
+    /// and <see cref="NamedPipeLoggerServer"/>.
+    /// </summary>
     public class PipeLoggerServer : EventArgsDispatcher, IDisposable
     {
         // This comes from https://github.com/KirillOsenkov/MSBuildStructuredLog/blob/master/src/StructuredLogger/BinaryLogger/BinaryLogger.cs
@@ -18,6 +22,10 @@ public class PipeLoggerServer : EventArgsDispatcher, IDisposable
         private readonly BinaryReader _binaryReader;
         private readonly Func<BuildEventArgs> _read;
 
+        /// <summary>
+        /// Creates a server that receives MSBuild events over a specified pipe.
+        /// </summary>
+        /// <param name="pipeStream">The pipe to receive events from.</param>
         public PipeLoggerServer(PipeStream pipeStream)
         {
             PipeStream = pipeStream;
@@ -42,6 +50,11 @@ public PipeLoggerServer(PipeStream pipeStream)
 
         protected PipeStream PipeStream { get; }
 
+        /// <summary>
+        /// Reads a single event from the pipe. This method blocks until an event is received,
+        /// there are no more events, or the pipe is closed.
+        /// </summary>
+        /// <returns><c>true</c> if an event was read, <c>false</c> otherwise.</returns>
         public virtual bool Read()
         {
             // Now read one message from the stream
@@ -61,6 +74,7 @@ public virtual bool Read()
             return false;
         }
 
+        /// <inheritdoc/>
         public void Dispose()
         {
             _binaryReader.Dispose();