Merge pull request #103 from itsharppro/dev

(#100) docs: update documentation
itsharppro · Sep 29, 2024 · 9d2686c · 9d2686c
2 parents 3623af0 + ce6cb66
commit 9d2686c
Show file tree

Hide file tree

Showing 38 changed files with 951 additions and 64 deletions.
diff --git a/.github/workflows/build-test-pack.yml b/.github/workflows/build-test-pack.yml
@@ -42,7 +42,7 @@ jobs:
  path: src/*/TestResults/
 
  publish:
- if: github.ref == 'refs/heads/dev'
+ if: github.ref == 'refs/heads/main'
  needs: build_test
  runs-on: ubuntu-latest
 

diff --git a/docs/logo/Paralax_logo_128.png b/docs/logo/Paralax_logo_128.png
diff --git a/src/Paralax.Auth.Distributed/src/Paralax.Auth.Distributed/Paralax.Auth.Distributed.csproj b/src/Paralax.Auth.Distributed/src/Paralax.Auth.Distributed/Paralax.Auth.Distributed.csproj
@@ -1,12 +1,41 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.Auth.Distributed - A distributed authentication framework for microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; authentication; distributed; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.Auth.Distributed library for managing distributed authentication in scalable services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.Auth.Distributed</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="Paralax" Version="*" />
  <PackageReference Include="Paralax.Auth" Version="*" />
  </ItemGroup>

diff --git a/src/Paralax.Auth/src/Paralax.Auth/Paralax.Auth.csproj b/src/Paralax.Auth/src/Paralax.Auth/Paralax.Auth.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.Auth - A framework for authentication in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; authentication; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.Auth library for managing authentication in scalable services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.Auth</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.8" />
  <PackageReference Include="Microsoft.AspNetCore.Authorization" Version="8.0.8" />
  <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.0.0" />

diff --git a/src/Paralax.CQRS.Commands/src/Paralax.CQRS.Commands/Paralax.CQRS.Commands.csproj b/src/Paralax.CQRS.Commands/src/Paralax.CQRS.Commands/Paralax.CQRS.Commands.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
- <PropertyGroup>
+ <PropertyGroup>
+ <Description>Paralax.CQRS.Commands - Command handling for CQRS in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; cqrs; commands; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.CQRS.Commands library for managing command handling in scalable CQRS services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.CQRS.Commands</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="Paralax" Version="*" />
  <PackageReference Include="Scrutor" Version="4.2.2" />
  </ItemGroup>

diff --git a/...ralax.CQRS.EventSourcing/src/Paralax.CQRS.EventSourcing/Paralax.CQRS.EventSourcing.csproj b/...ralax.CQRS.EventSourcing/src/Paralax.CQRS.EventSourcing/Paralax.CQRS.EventSourcing.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.CQRS.EventSourcing - Event sourcing for CQRS in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; cqrs; event sourcing; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.CQRS.EventSourcing library for managing event sourcing in scalable CQRS services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.CQRS.EventSourcing</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="Paralax" Version="*" />
  <PackageReference Include="Paralax.CQRS.Events" Version="*" />
  </ItemGroup>

diff --git a/src/Paralax.CQRS.Events/src/Paralax.CQRS.Events.csproj b/src/Paralax.CQRS.Events/src/Paralax.CQRS.Events.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.CQRS.Events - Event handling for CQRS in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; cqrs; events; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.CQRS.Events library for managing event handling in scalable CQRS services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.CQRS.Events</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="MessagePack" Version="2.5.172" />
  <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
  <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />

diff --git a/src/Paralax.CQRS.Logging/src/Paralax.CQRS.Logging/Paralax.CQRS.Logging.csproj b/src/Paralax.CQRS.Logging/src/Paralax.CQRS.Logging/Paralax.CQRS.Logging.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.CQRS.Logging - Logging for CQRS in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; cqrs; logging; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.CQRS.Logging library for handling CQRS-related logging in scalable services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.CQRS.Logging</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="Paralax" Version="*" />
  <PackageReference Include="Paralax.Logging" Version="*" />
  <PackageReference Include="Paralax.CQRS.Commands" Version="*" />

diff --git a/src/Paralax.CQRS.Queries/src/Paralax.CQRS.Queries/Paralax.CQRS.Queries.csproj b/src/Paralax.CQRS.Queries/src/Paralax.CQRS.Queries/Paralax.CQRS.Queries.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.CQRS.Queries - Query handling for CQRS in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; cqrs; queries; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.CQRS.Queries library for handling CQRS queries in scalable services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.CQRS.Queries</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="MessagePack" Version="2.5.172" />
  <PackageReference Include="Paralax" Version="*" />
  <PackageReference Include="Scrutor" Version="4.2.2" />

diff --git a/src/Paralax.CQRS.WebApi/src/Paralax.CQRS.WebApi/Paralax.CQRS.WebApi.csproj b/src/Paralax.CQRS.WebApi/src/Paralax.CQRS.WebApi/Paralax.CQRS.WebApi.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.CQRS.WebApi - CQRS integration for Web API services</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; cqrs; webapi; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.CQRS.WebApi library for integrating CQRS in Web API services.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.CQRS.WebApi</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="NetJSON" Version="1.4.4" />
  <PackageReference Include="Paralax.CQRS.Commands" Version="*" />
  <PackageReference Include="Paralax.CQRS.Events" Version="*" />

diff --git a/src/Paralax.Discovery.Consul/src/Paralax.Discovery.Consul/Paralax.Discovery.Consul.csproj b/src/Paralax.Discovery.Consul/src/Paralax.Discovery.Consul/Paralax.Discovery.Consul.csproj
@@ -1,12 +1,40 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
+ <Description>Paralax.Discovery.Consul - Consul integration for service discovery in microservices architecture</Description>
+ <Authors>ITSharpPro</Authors>
+ <Company>ITSharpPro</Company>
+ <PackageProjectUrl>https://itsharppro.com</PackageProjectUrl>
+ <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+ <RepositoryUrl>https://github.com/ITSharpPro/Paralax</RepositoryUrl>
+ <RepositoryType>git</RepositoryType>
+ <PackageTags>microservices; consul; service-discovery; framework; ITSharpPro</PackageTags>
+ <PackageReleaseNotes>
+ Initial release of the Paralax.Discovery.Consul library for Consul-based service discovery in microservices architecture.
+ </PackageReleaseNotes>
+ <Copyright>ITSharpPro © $(Year)</Copyright>
  <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
+ <LangVersion>latest</LangVersion>
+
+ <PackageId>Paralax.Discovery.Consul</PackageId>
+ <PackageIcon>Paralax_logo_128.png</PackageIcon> 
+ <PackageReadmeFile>README.md</PackageReadmeFile>
+ <IsPackable>true</IsPackable>
  </PropertyGroup>
 
  <ItemGroup>
+ <None Include="../../../../README.md">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
+ <None Include="../../../../docs/logo/Paralax_logo_128.png">
+ <Pack>True</Pack>
+ <PackagePath>\</PackagePath>
+ </None>
+
  <PackageReference Include="Paralax.HTTP" Version="*" />
  </ItemGroup>