Merge pull request #58 from Encamina/@vmunoz/add-readme-to-packages

Added Readme file to all solution's projects.
Encamina · Jan 22, 2024 · e82f260 · e82f260
2 parents a72a083 + 0ed78a8
commit e82f260
Show file tree

Hide file tree

Showing 44 changed files with 348 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -37,7 +37,8 @@ Previous classification is not required if changes are simple or all belong to t
 - Fixed some typos and grammatical errors (mostly on code comments).
 - Added new extension method `AddDefaultDocumentConnectorProvider` in `Encamina.Enmarcha.SemanticKernel.Connectors.Document` to get access to a default implementation of a `IDocumentConnector`.
 - Updated sample projects with latest changes.
-- Overloaded `AddDefaultDocumentConnectorProvider` and `AddDefaultDocumentContentExtractor` methods with a parameter for pass it a function to calculate the length of a text and inject it as a dependency.
+- Overloaded `AddDefaultDocumentConnectorProvider` and `AddDefaultDocumentContentExtractor` methods with a parameter to pass a function to calculate the length of a text and inject it as a dependency.
+- Added Readme file to all solution's projects.
 
 ## [8.1.1]
 

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -17,7 +17,7 @@
 
   <PropertyGroup>
     <VersionPrefix>8.1.2</VersionPrefix>
-    <VersionSuffix>preview-9</VersionSuffix>
+    <VersionSuffix>preview-10</VersionSuffix>
   </PropertyGroup>
 
   <!--

diff --git a/src/Encamina.Enmarcha.AI.Abstractions/Encamina.Enmarcha.AI.Abstractions.csproj b/src/Encamina.Enmarcha.AI.Abstractions/Encamina.Enmarcha.AI.Abstractions.csproj
@@ -1,9 +1,13 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Options" Version="8.0.1" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
@@ -13,4 +17,8 @@
     <ProjectReference Include="..\Encamina.Enmarcha.Entities.Abstractions\Encamina.Enmarcha.Entities.Abstractions.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/...tionsAnalysis.Abstractions/Encamina.Enmarcha.AI.ConversationsAnalysis.Abstractions.csproj b/...tionsAnalysis.Abstractions/Encamina.Enmarcha.AI.ConversationsAnalysis.Abstractions.csproj
@@ -1,11 +1,19 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/...IntentsPrediction.Abstractions/Encamina.Enmarcha.AI.IntentsPrediction.Abstractions.csproj b/...IntentsPrediction.Abstractions/Encamina.Enmarcha.AI.IntentsPrediction.Abstractions.csproj
@@ -4,9 +4,17 @@
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
     <ProjectReference Include="..\Encamina.Enmarcha.Entities.Abstractions\Encamina.Enmarcha.Entities.Abstractions.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
 </Project>
diff --git a/...a.Enmarcha.AI.IntentsPrediction.Azure/Encamina.Enmarcha.AI.IntentsPrediction.Azure.csproj b/...a.Enmarcha.AI.IntentsPrediction.Azure/Encamina.Enmarcha.AI.IntentsPrediction.Azure.csproj
@@ -4,6 +4,10 @@
         <TargetFramework>netstandard2.1</TargetFramework>
     </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="Azure.AI.Language.Conversations" Version="1.1.0" />
         <PackageReference Include="Azure.Core" Version="1.37.0" />
@@ -17,4 +21,8 @@
         <ProjectReference Include="..\Encamina.Enmarcha.AI.IntentsPrediction.Abstractions\Encamina.Enmarcha.AI.IntentsPrediction.Abstractions.csproj" />
         <ProjectReference Include="..\Encamina.Enmarcha.AI\Encamina.Enmarcha.AI.csproj" />
     </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 </Project>
diff --git a/...nguagesDetection.Abstractions/Encamina.Enmarcha.AI.LanguagesDetection.Abstractions.csproj b/...nguagesDetection.Abstractions/Encamina.Enmarcha.AI.LanguagesDetection.Abstractions.csproj
@@ -3,6 +3,10 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
@@ -23,5 +27,9 @@
       <LastGenOutput>ExceptionMessages.Designer.cs</LastGenOutput>
     </EmbeddedResource>
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
 
 </Project>
diff --git a/...Enmarcha.AI.LanguagesDetection.Azure/Encamina.Enmarcha.AI.LanguagesDetection.Azure.csproj b/...Enmarcha.AI.LanguagesDetection.Azure/Encamina.Enmarcha.AI.LanguagesDetection.Azure.csproj
@@ -3,6 +3,10 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Azure.AI.TextAnalytics" Version="5.3.0" />
@@ -36,4 +40,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Encamina.Enmarcha.AI.OpenAI.Abstractions/Encamina.Enmarcha.AI.OpenAI.Abstractions.csproj b/src/Encamina.Enmarcha.AI.OpenAI.Abstractions/Encamina.Enmarcha.AI.OpenAI.Abstractions.csproj
@@ -3,11 +3,19 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Encamina.Enmarcha.Core\Encamina.Enmarcha.Core.csproj" />
     <ProjectReference Include="..\Encamina.Enmarcha.Entities.Abstractions\Encamina.Enmarcha.Entities.Abstractions.csproj" />
     <ProjectReference Include="..\Encamina.Enmarcha.Entities\Encamina.Enmarcha.Entities.csproj" />
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
 
 </Project>
diff --git a/src/Encamina.Enmarcha.AI.OpenAI.Azure/Encamina.Enmarcha.AI.OpenAI.Azure.csproj b/src/Encamina.Enmarcha.AI.OpenAI.Azure/Encamina.Enmarcha.AI.OpenAI.Azure.csproj
@@ -4,6 +4,10 @@
         <TargetFramework>netstandard2.1</TargetFramework>
     </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="Azure.AI.OpenAI" Version="1.0.0-beta.12" />
         <PackageReference Include="Microsoft.Extensions.Azure" Version="1.7.1" />
@@ -18,5 +22,9 @@
         <ProjectReference Include="..\Encamina.Enmarcha.Core\Encamina.Enmarcha.Core.csproj" />
         <ProjectReference Include="..\Encamina.Enmarcha.Entities\Encamina.Enmarcha.Entities.csproj" />
     </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 
 </Project>
diff --git a/...estionsAnswering.Abstractions/Encamina.Enmarcha.AI.QuestionsAnswering.Abstractions.csproj b/...estionsAnswering.Abstractions/Encamina.Enmarcha.AI.QuestionsAnswering.Abstractions.csproj
@@ -1,8 +1,12 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
@@ -23,5 +27,9 @@
       <LastGenOutput>ExceptionMessages.Designer.cs</LastGenOutput>
     </EmbeddedResource>
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
 
 </Project>
diff --git a/...Enmarcha.AI.QuestionsAnswering.Azure/Encamina.Enmarcha.AI.QuestionsAnswering.Azure.csproj b/...Enmarcha.AI.QuestionsAnswering.Azure/Encamina.Enmarcha.AI.QuestionsAnswering.Azure.csproj
@@ -1,8 +1,12 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Azure.AI.Language.QuestionAnswering" Version="1.1.0" />
@@ -19,5 +23,9 @@
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
     <ProjectReference Include="..\Encamina.Enmarcha.AI\Encamina.Enmarcha.AI.csproj" />
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
 
 </Project>
diff --git a/...I.TextsTranslation.Abstractions/Encamina.Enmarcha.AI.TextsTranslation.Abstractions.csproj b/...I.TextsTranslation.Abstractions/Encamina.Enmarcha.AI.TextsTranslation.Abstractions.csproj
@@ -3,6 +3,10 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.0" />
@@ -12,5 +16,9 @@
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
     <ProjectReference Include="..\Encamina.Enmarcha.Entities.Abstractions\Encamina.Enmarcha.Entities.Abstractions.csproj" />
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
 
 </Project>
diff --git a/...ina.Enmarcha.AI.TextsTranslation.Azure/Encamina.Enmarcha.AI.TextsTranslation.Azure.csproj b/...ina.Enmarcha.AI.TextsTranslation.Azure/Encamina.Enmarcha.AI.TextsTranslation.Azure.csproj
@@ -3,6 +3,10 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
 
   <ItemGroup>
     <Compile Remove="Extensions\ITextTranslationServiceBuilderExtensions.cs" />
@@ -40,5 +44,9 @@
       <Generator>ResXFileCodeGenerator</Generator>
     </EmbeddedResource>
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
 
 </Project>
diff --git a/src/Encamina.Enmarcha.AI/Encamina.Enmarcha.AI.csproj b/src/Encamina.Enmarcha.AI/Encamina.Enmarcha.AI.csproj
@@ -4,6 +4,10 @@
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Encamina.Enmarcha.AI.Abstractions\Encamina.Enmarcha.AI.Abstractions.csproj" />
     <ProjectReference Include="..\Encamina.Enmarcha.AI.ConversationsAnalysis.Abstractions\Encamina.Enmarcha.AI.ConversationsAnalysis.Abstractions.csproj" />
@@ -32,4 +36,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Encamina.Enmarcha.AspNet.Mvc.Formatters/Encamina.Enmarcha.AspNet.Mvc.Formatters.csproj b/src/Encamina.Enmarcha.AspNet.Mvc.Formatters/Encamina.Enmarcha.AspNet.Mvc.Formatters.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
@@ -8,8 +8,16 @@
         <IsPackable>true</IsPackable>
     </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>
       <ProjectReference Include="..\Encamina.Enmarcha.Net.Http\Encamina.Enmarcha.Net.Http.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
 </Project>
diff --git a/src/Encamina.Enmarcha.AspNet.Mvc/Encamina.Enmarcha.AspNet.Mvc.csproj b/src/Encamina.Enmarcha.AspNet.Mvc/Encamina.Enmarcha.AspNet.Mvc.csproj
@@ -8,9 +8,17 @@
         <IsPackable>true</IsPackable>
     </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.1" />
         <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="8.0.1" />
     </ItemGroup>
 
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
 </Project>
diff --git a/...a.Enmarcha.AspNet.OpenApi.Swashbuckle/Encamina.Enmarcha.AspNet.OpenApi.Swashbuckle.csproj b/...a.Enmarcha.AspNet.OpenApi.Swashbuckle/Encamina.Enmarcha.AspNet.OpenApi.Swashbuckle.csproj
@@ -8,9 +8,17 @@
         <IsPackable>true</IsPackable>
     </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>      
       <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.0.0" />
       <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.5.0" />
     </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 
 </Project>
diff --git a/src/Encamina.Enmarcha.Bot.Abstractions/Encamina.Enmarcha.Bot.Abstractions.csproj b/src/Encamina.Enmarcha.Bot.Abstractions/Encamina.Enmarcha.Bot.Abstractions.csproj
@@ -4,6 +4,10 @@
         <TargetFramework>netstandard2.1</TargetFramework>
     </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
         <PackageReference Include="Microsoft.Bot.Builder.Dialogs" Version="4.21.2" />
@@ -15,4 +19,8 @@
         <ProjectReference Include="..\Encamina.Enmarcha.Entities.Abstractions\Encamina.Enmarcha.Entities.Abstractions.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
 </Project>
diff --git a/...marcha.Bot.Skills.QuestionAnswering/Encamina.Enmarcha.Bot.Skills.QuestionAnswering.csproj b/...marcha.Bot.Skills.QuestionAnswering/Encamina.Enmarcha.Bot.Skills.QuestionAnswering.csproj
@@ -1,9 +1,13 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
 
+    <PropertyGroup>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
         <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="8.0.0" />
@@ -38,5 +42,9 @@
       <LastGenOutput>ResponseMessages.Designer.cs</LastGenOutput>
     </EmbeddedResource>
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
 
 </Project>