docs: add bare package README.md (#58)

skwasjer · Aug 31, 2023 · 28f4e27 · 28f4e27
1 parent c6659fe
commit 28f4e27
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 1 deletion.
diff --git a/src/Correlate.Abstractions/Correlate.Abstractions.csproj b/src/Correlate.Abstractions/Correlate.Abstractions.csproj
@@ -6,9 +6,13 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <Description>Provides abtractions to correlate requests between microservices.</Description>
+    <Description>Provides abstractions to correlate requests between microservices.</Description>
     <PackageProjectUrl>https://github.com/skwasjer/Correlate</PackageProjectUrl>
     <PackageTags>correlationid, correlation, correlate, causation, aspnet, middleware, httpclient, httpclientfactory</PackageTags>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
 </Project>
diff --git a/src/Correlate.Abstractions/README.md b/src/Correlate.Abstractions/README.md
@@ -0,0 +1,7 @@
+ASP.NET Core middleware component to correlate requests between microservices using correlation ID request headers.
+
+### Useful links
+
+- [GitHub / docs](https://github.com/skwasjer/Correlate)
+- [Changelog](https://github.com/skwasjer/Correlate/releases)
+- [Examples](https://github.com/skwasjer/Correlate/tree/main/examples)
diff --git a/src/Correlate.AspNetCore/Correlate.AspNetCore.csproj b/src/Correlate.AspNetCore/Correlate.AspNetCore.csproj
@@ -15,6 +15,10 @@
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Correlate.DependencyInjection\Correlate.DependencyInjection.csproj" />
   </ItemGroup>

diff --git a/src/Correlate.AspNetCore/README.md b/src/Correlate.AspNetCore/README.md
@@ -0,0 +1,7 @@
+Provides abstractions to correlate requests between microservices.
+
+### Useful links
+
+- [GitHub / docs](https://github.com/skwasjer/Correlate)
+- [Changelog](https://github.com/skwasjer/Correlate/releases)
+- [Examples](https://github.com/skwasjer/Correlate/tree/main/examples)
diff --git a/src/Correlate.Core/Correlate.Core.csproj b/src/Correlate.Core/Correlate.Core.csproj
@@ -13,6 +13,10 @@
     <PackageTags>correlationid, correlation, correlate, causation, aspnet, middleware, httpclient, httpclientfactory</PackageTags>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="$(PackageVersion_Microsoft_Extensions)" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="$(PackageVersion_Microsoft_Extensions)" />

diff --git a/src/Correlate.Core/README.md b/src/Correlate.Core/README.md
@@ -0,0 +1,7 @@
+Correlate requests between microservices using a correlation ID.
+
+### Useful links
+
+- [GitHub / docs](https://github.com/skwasjer/Correlate)
+- [Changelog](https://github.com/skwasjer/Correlate/releases)
+- [Examples](https://github.com/skwasjer/Correlate/tree/main/examples)
diff --git a/src/Correlate.DependencyInjection/Correlate.DependencyInjection.csproj b/src/Correlate.DependencyInjection/Correlate.DependencyInjection.csproj
@@ -10,6 +10,10 @@
     <PackageTags>correlationid, correlation, correlate, causation, aspnet, middleware, httpclient, httpclientfactory</PackageTags>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Http" Version="$(PackageVersion_Microsoft_Extensions)" />
   </ItemGroup>

diff --git a/src/Correlate.DependencyInjection/README.md b/src/Correlate.DependencyInjection/README.md
@@ -0,0 +1,23 @@
+Dependency injection extensions for Correlate.
+
+### Dependency registration example
+
+```csharp
+var services = new ServiceCollection();
+services.AddCorrelate();
+```
+
+### HttpClient delegating handler example
+
+```csharp
+var services = new ServiceCollection();
+services
+    .AddHttpClient<MyService>()
+    .CorrelateRequests();
+```
+
+### Useful links
+
+- [GitHub / docs](https://github.com/skwasjer/Correlate)
+- [Changelog](https://github.com/skwasjer/Correlate/releases)
+- [Examples](https://github.com/skwasjer/Correlate/tree/main/examples)