Updates to GitHub ReadMe documentation, and created a smaller ReadMe for Nuget packages

Author: MattEdwardsWaggleBee

README.md

@@ -1,15 +1,12 @@
 # Hyperbee.Pipeline
 
-Classes for building composable async pipelines supporting:
+The `Hyperbee.Pipeline` library is a sophisticated tool for constructing asynchronous fluent pipelines in .NET. A pipeline, in this context, refers to a sequence of data processing elements arranged in series, where the output of one element serves as the input for the subsequent element.
 
-  * Value projections
-  * Early returns
-  * Child pipelines
-  * [Middleware](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/middleware.md)
-  * [Conditional flow](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/execution.md)
-  * [Dependency Injection](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/dependencyInjection.md)
+A distinguishing feature of the `Hyperbee.Pipeline` library, setting it apart from other pipeline implementations, is its inherent support for **middleware** and **dependency injection**. Middleware introduces a higher degree of flexibility and control over the data flow, enabling developers to manipulate data as it traverses through the pipeline. This can be leveraged to implement a variety of functionalities such as eventing, caching, logging, and more, thereby enhancing the customizability of the code.
 
-## Usage
+Furthermore, the support for dependency injection facilitates efficient management of dependencies within the pipeline. This leads to code that is more maintainable and testable, thereby improving the overall quality of the software.
+
+## Example
 
 ```csharp
 // Takes a string and returns a number
@@ -28,6 +25,190 @@ Assert.AreEqual(42, answer1);
 var answer2 = await question(new PipelineContext(), "Smith");
 Assert.AreEqual(0, answer2);
 ```
+## Middleware
+
+Hyperbee pipelines come with the ability to enhance processing with custom middleware. The `PipelineFactory` library provides functionality that allows you to manipulate the data as it passes through the pipeline. This is done using the `Hook` and `Wrap` methods.
+
+### Hook
+
+The `Hook` and `HookAsync` methods allow you to add a hook that is called for every statement in the pipeline. This hook takes the current context, the current argument, and a delegate to the next part of the pipeline. It can manipulate the argument before and after calling the next part of the pipeline.
+
+Here's an example of how to use `HookAsync`:
+
+```csharp
+var command = PipelineFactory
+    .Start<string>()
+    .HookAsync( async ( ctx, arg, next ) => await next( ctx, arg + "{" ) + "}" )
+    .Pipe( ( ctx, arg ) => arg + "1" )
+    .Pipe( ( ctx, arg ) => arg + "2" )
+    .Build();
+
+var result = await command( new PipelineContext() );
+
+Assert.AreEqual( "{1}{2}", result );
+```
+
+### Wrap
+
+The `Wrap` and `WrapAsync` method allows you to wrap a part of the pipeline. This is useful when you want to apply a transformation to only a part of the pipeline.
+
+Here’s an example of how to use `WrapAsync`:
+
+```csharp
+var command = PipelineFactory
+    .Start<string>()
+    .Pipe( ( ctx, arg ) => arg + "1" )
+    .Pipe( ( ctx, arg ) => arg + "2" )
+    .WrapAsync( async ( ctx, arg, next ) => await next( ctx, arg + "{" ) + "}" )
+    .Pipe( ( ctx, arg ) => arg + "3" )
+    .Build();
+
+var result = await command( new PipelineContext() );
+
+Assert.AreEqual( "{12}3", result );
+
+```
+
+## Dependency Injection
+
+Sometimes Pipelines and Pipeline middleware need access to specific container services. This can be
+accomplished by registering services with the `PipelineContextFactory`. This can be done through
+DI configuration, or manually through the `PipelineContextFactoryProvider` if you are not using DI.
+
+Pipelines manage dependencies with a specialized container. This allows the implementor to control
+the services that are exposed through the pipeline. If you want to expose all application
+services then you can call `AddPipeline` and pass `includeAllServices: true`. 
+
+Register pipelines with DI and provide Pipeline dependencies using the application container.
+
+```csharp
+services.AddPipeline( includeAllServices: true );
+```
+
+Register Pipelines with DI and provide Pipeline dependencies using a specialized container.
+
+```csharp
+services.AddPipeline( (factoryServices, rootProvider) =>
+{
+    factoryServices.AddTransient<IThing>()
+    factoryServices.ProxyService<IPrincipalProvider>( rootProvider ); // pull from root container
+} );
+```
+
+## Advanced Features
+
+The `PipelineFactory` library provides a variety of helper methods that allow you to customize the behavior of your pipelines. These methods provide powerful functionality for manipulating data as it passes through the pipeline.
+
+### Reduce
+
+The `Reduce` and `ReduceAsync` methods allow you to reduce a sequence of elements to a single value. You can specify a reducer function that defines how the elements should be combined, and a builder function that creates the pipeline for processing the elements.
+
+### WaitAll
+
+The `WaitAll` method allows you to wait for all pipelines to complete before continuing. You can specify a set of builders that create the pipelines to wait for, a reducer function that combines the results of the pipelines.
+
+```csharp
+var count = 0;
+
+var command = PipelineFactory
+    .Start<int>()
+    .WaitAll( builders => builders.Create(
+            builder => builder.Pipe( ( ctx, arg ) => Interlocked.Increment( ref count ) ),
+            builder => builder.Pipe( ( ctx, arg ) => Interlocked.Increment( ref count ) )
+        ),
+        reducer: ( ctx, arg, results ) => { return arg + results.Sum( x => (int) x.Result ); }
+    )
+    .Build();
+
+var result = await command( new PipelineContext() );
+
+Assert.AreEqual( 2, count );
+Assert.AreEqual( 3, result );
+```
+
+### PipeIf
+
+The `PipeIf` method allows you to conditionally add a step to the pipeline. You can specify a condition function that determines whether the step should be added, a builder function that creates the step, and an optional flag indicating whether middleware should be inherited.
+
+### ForEach and ForEachAsync
+
+The `ForEach` and `ForEachAsync` methods allow you to apply a pipeline to each element in a sequence. You can specify a builder function that creates the pipeline for processing the elements.
+
+```csharp
+var count = 0;
+
+var command = PipelineFactory
+    .Start<string>()
+    .Pipe( ( ctx, arg ) => arg.Split( ' ' ) )
+    .ForEach<string>( builder => builder
+        .Pipe( ( ctx, arg ) => count += 10 )
+    )
+    .Pipe( ( ctx, arg ) => count += 5 )
+    .Build();
+
+await command( new PipelineContext(), "e f" );
+
+Assert.AreEqual( count, 25 );
+```
+
+### Call and CallAsync
+
+The `Call` and `CallAsync` methods allow you to add a procedure to the pipeline. You can think of these as `Action<T>` and `Pipe` like `Func<T>`.
+
+In this example notice that `arg + 9` is not returned from the use of `Call`
+
+```csharp
+var callResult = string.Empty;
+
+var command = PipelineFactory
+    .Start<string>()
+    .Pipe( ( ctx, arg ) => arg + "1" )
+    .Pipe( ( ctx, arg ) => arg + "2" )
+    .Call( builder => builder
+        .Call( ( ctx, arg ) => callResult = arg + "3" )
+        .Pipe( ( ctx, arg ) => arg + "9" )
+    )
+    .Pipe( ( ctx, arg ) => arg + "4" )
+    .Build();
+
+var result = await command( new PipelineContext() );
+
+Assert.AreEqual( "124", result );
+Assert.AreEqual( "123", callResult );
+```
+
+### Chaining Child Pipelines
+
+The `PipelineFactory` library allows you to chain pipelines together. Since pipelines are just functions, they can be used as input to other pipelines. This allows you to create complex data processing flows by reusing and chaining together multiple pipelines.
+
+Here's an example of how to chain pipelines together:
+
+```csharp
+var command2 = PipelineFactory
+    .Start<string>()
+    .Pipe( ( ctx, arg ) => $"{arg} again!" )
+    .Build();
+
+var command1 = PipelineFactory
+    .Start<string>()
+    .Pipe( ( ctx, arg ) => $"hello {arg}" )
+    .PipeAsync( command2 )
+    .Build();
+
+var result = await command1( new PipelineContext(), "pipeline" );
+
+Assert.AreEqual( "hello pipeline again!", result );
+```
+
+## Additional Documentation 
+Classes for building composable async pipelines supporting:
+
+  * [Middleware](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/middleware.md)
+  * [Conditional flow](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/execution.md)
+  * [Dependency Injection](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/dependencyInjection.md)
+  * Value projections
+  * Early returns
+  * Child pipelines
 
 # Status
 
@@ -37,7 +218,5 @@ Assert.AreEqual(0, answer2);
 | `main`     | [![Build status](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/actions/workflows/publish.yml/badge.svg)](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/actions/workflows/publish.yml)                 |
 
 
-[![Hyperbee.Pipeline](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/assets/hyperbee.jpg?raw=true)](https://github.com/Stillpoint-Software/Hyperbee.Pipeline)
-
 # Help
- See [Todo](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/todo.md)
+ See our list of items [Todo](https://github.com/Stillpoint-Software/Hyperbee.Pipeline/blob/main/docs/todo.md)

src/Hyperbee.Pipeline/Hyperbee.Pipeline.csproj

@@ -29,7 +29,7 @@
     <Pack>True</Pack>
     <PackagePath>\</PackagePath>
   </None>
-	<None Include="..\..\README.md">
+	<None Include="README.md">
 	  <Pack>True</Pack>
 	  <PackagePath>\</PackagePath>
 	</None>

src/Hyperbee.Pipeline/README.md

@@ -0,0 +1,25 @@
+# Hyperbee.Pipeline
+
+The `Hyperbee.Pipeline` library is a sophisticated tool for constructing asynchronous fluent pipelines in .NET. A pipeline, in this context, refers to a sequence of data processing elements arranged in series, where the output of one element serves as the input for the subsequent element.
+
+A distinguishing feature of the `Hyperbee.Pipeline` library, setting it apart from other pipeline implementations, is its inherent support for **middleware** and **dependency injection**. Middleware introduces a higher degree of flexibility and control over the data flow, enabling developers to manipulate data as it traverses through the pipeline. This can be leveraged to implement a variety of functionalities such as eventing, caching, logging, and more, thereby enhancing the customizability of the code.
+
+Furthermore, the support for dependency injection facilitates efficient management of dependencies within the pipeline. This leads to code that is more maintainable and testable, thereby improving the overall quality of the software.
+
+```csharp
+// Takes a string and returns a number
+var question = PipelineFactory
+    .Start<string>()
+    .PipeIf((ctx, arg) => arg == "Adams", builder => builder
+        .Pipe((ctx, arg) => 42)
+        .Cancel()
+    )
+    .Pipe((ctx, arg) => 0)
+    .Build();
+
+var answer1 = await question(new PipelineContext(), "Adams");
+Assert.AreEqual(42, answer1);
+
+var answer2 = await question(new PipelineContext(), "Smith");
+Assert.AreEqual(0, answer2);
+```