chore: added README to all packages

-updated dependencies
jcamp-code · Nov 23, 2023 · 8801ddd · 8801ddd
1 parent 05cfca2
commit 8801ddd
Show file tree

Hide file tree

Showing 27 changed files with 153 additions and 24 deletions.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -9,7 +9,7 @@
     <PackageProjectUrl>https://github.com/jcamp-code/FluentEmail</PackageProjectUrl>
     <RepositoryUrl>https://github.com/jcamp-code/FluentEmail</RepositoryUrl>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Version>3.5.1</Version>
 

diff --git a/src/FluentEmail.Core/FluentEmail.Core.csproj b/src/FluentEmail.Core/FluentEmail.Core.csproj
@@ -7,12 +7,18 @@
     <AssetsDirectory>../../assets</AssetsDirectory>
     <PackageId>jcamp.$(AssemblyName)</PackageId>
     <Product>jcamp.$(AssemblyName)</Product>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <!--<Target Name="PostcompileScript" AfterTargets="Build" Condition=" '$(IsCrossTargetingBuild)' != 'true' ">
     <Exec Command="dotnet pack -no-build -configuration $(Configuration)" />
   </Target>-->
 
+  <ItemGroup>
+    <None Include="../../README.md" Pack="true" Visible="false" PackagePath="\"/>
+  </ItemGroup>
+
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="6.0.0" />
   </ItemGroup>

diff --git a/src/Renderers/FluentEmail.Liquid/FluentEmail.Liquid.csproj b/src/Renderers/FluentEmail.Liquid/FluentEmail.Liquid.csproj
@@ -14,11 +14,15 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Fluid.Core" Version="2.3.1" />
+    <PackageReference Include="Fluid.Core" Version="2.5.0" />
     <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="6.0.13" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="6.0.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
   </ItemGroup>

diff --git a/src/Renderers/FluentEmail.Liquid/README.md b/src/Renderers/FluentEmail.Liquid/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## Liquid Renderer for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Generate emails using [Liquid templates](https://shopify.github.io/liquid/). Uses the [Fluid](https://github.com/sebastienros/fluid) project under the hood.
diff --git a/src/Renderers/FluentEmail.Razor/FluentEmail.Razor.csproj b/src/Renderers/FluentEmail.Razor/FluentEmail.Razor.csproj
@@ -15,6 +15,10 @@
     <PackageReference Include="RazorLight" Version="2.3.1" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
   </ItemGroup>

diff --git a/src/Renderers/FluentEmail.Razor/README.md b/src/Renderers/FluentEmail.Razor/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## Razor Renderer for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Generate emails using Razor templates. Anything you can do in ASP.NET is possible here. Uses the [RazorLight](https://github.com/toddams/RazorLight) project under the hood.
diff --git a/src/Senders/FluentEmail.Azure.Email/FluentEmail.Azure.Email.csproj b/src/Senders/FluentEmail.Azure.Email/FluentEmail.Azure.Email.csproj
@@ -14,6 +14,10 @@
         <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
     <ItemGroup>
       <PackageReference Include="Azure.Communication.Email" Version="1.0.1" />
     </ItemGroup>

diff --git a/src/Senders/FluentEmail.Azure.Email/README.md b/src/Senders/FluentEmail.Azure.Email/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## Azure Email Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send emails via Azure Email Communication Services API
diff --git a/src/Senders/FluentEmail.Graph/FluentEmail.Graph.csproj b/src/Senders/FluentEmail.Graph/FluentEmail.Graph.csproj
@@ -16,6 +16,10 @@
     <PackageReference Include="Microsoft.Identity.Client" Version="4.49.1" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
   </ItemGroup>

diff --git a/src/Senders/FluentEmail.Graph/README.md b/src/Senders/FluentEmail.Graph/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## Microsoft Graph Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send emails via Microsoft Graph's APIs
diff --git a/src/Senders/FluentEmail.MailKit/FluentEmail.MailKit.csproj b/src/Senders/FluentEmail.MailKit/FluentEmail.MailKit.csproj
@@ -15,6 +15,10 @@
     <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="MailKit" Version="4.3.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="6.0.0" />

diff --git a/src/Senders/FluentEmail.MailKit/README.md b/src/Senders/FluentEmail.MailKit/README.md
@@ -0,0 +1,9 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## MailKit Email Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send emails using the [MailKit](https://github.com/jstedfast/MailKit) email library.
+
+This is the recommended replacement for DotNet's built-in `SmtpClient`
diff --git a/src/Senders/FluentEmail.MailPace/FluentEmail.MailPace.csproj b/src/Senders/FluentEmail.MailPace/FluentEmail.MailPace.csproj
@@ -10,7 +10,11 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
+        <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/Senders/FluentEmail.MailPace/README.md b/src/Senders/FluentEmail.MailPace/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## MailPace Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send emails via the [MailPace](https://www.mailpace.com/) REST API.
diff --git a/src/Senders/FluentEmail.Mailgun/FluentEmail.Mailgun.csproj b/src/Senders/FluentEmail.Mailgun/FluentEmail.Mailgun.csproj
@@ -10,7 +10,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/Senders/FluentEmail.Mailgun/README.md b/src/Senders/FluentEmail.Mailgun/README.md
@@ -1,10 +1,10 @@
-# Fluent Email - MailGun  
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
 
-Send email via the MailGun REST API.
+# FluentEmail - All in one email sender for .NET and .NET Core
 
-## Packages
+## Mailgun Email Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
 
-`FluentEmail.Mailgun`
+Send email via the MailGun REST API.
 
 ## Usage
 
@@ -36,5 +36,3 @@ Send the email in the usual Fluent Email way.
 ## Further Information
 
 Don't forget you can use Razor templating using the [FluentEmail.Razor](../../Renderers/FluentEmail.Razor) package as well.
-
-If you'd like to create your own sender for another service, check out the source code. All you need to do is implement the `ISender` interface :)
diff --git a/src/Senders/FluentEmail.Mailtrap/FluentEmail.Mailtrap.csproj b/src/Senders/FluentEmail.Mailtrap/FluentEmail.Mailtrap.csproj
@@ -14,4 +14,8 @@
     <ProjectReference Include="..\FluentEmail.Smtp\FluentEmail.Smtp.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Senders/FluentEmail.Mailtrap/README.md b/src/Senders/FluentEmail.Mailtrap/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## Mailtrap Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send emails to Mailtrap.
diff --git a/src/Senders/FluentEmail.Postmark/FluentEmail.Postmark.csproj b/src/Senders/FluentEmail.Postmark/FluentEmail.Postmark.csproj
@@ -1,17 +1,21 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-  <PropertyGroup>
-    <Description>Send emails via Postmark using their REST API</Description>
-	<AssemblyTitle>Fluent Email - Postmark</AssemblyTitle>
-	<PackageTags>$(PackageTags);postmark</PackageTags>
-	<TargetFramework>net6.0</TargetFramework>
-	<PackageId>jcamp.$(AssemblyName)</PackageId>
-	<Product>jcamp.$(AssemblyName)</Product>
-  </PropertyGroup>
+    <PropertyGroup>
+        <Description>Send emails via Postmark using their REST API</Description>
+        <AssemblyTitle>Fluent Email - Postmark</AssemblyTitle>
+        <PackageTags>$(PackageTags);postmark</PackageTags>
+        <TargetFramework>net6.0</TargetFramework>
+        <PackageId>jcamp.$(AssemblyName)</PackageId>
+        <Product>jcamp.$(AssemblyName)</Product>
+    </PropertyGroup>
 
-  <ItemGroup>
-	<ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
-	<PackageReference Include="Postmark" Version="4.7.7" />
-  </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj"/>
+        <PackageReference Include="Postmark" Version="4.7.10"/>
+    </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 
 </Project>
diff --git a/src/Senders/FluentEmail.Postmark/README.md b/src/Senders/FluentEmail.Postmark/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## Postmark Email Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send emails via Postmark's REST API.
diff --git a/src/Senders/FluentEmail.SendGrid/FluentEmail.SendGrid.csproj b/src/Senders/FluentEmail.SendGrid/FluentEmail.SendGrid.csproj
@@ -14,6 +14,10 @@
     <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Sendgrid" Version="9.28.1" />
   </ItemGroup>

diff --git a/src/Senders/FluentEmail.SendGrid/README.md b/src/Senders/FluentEmail.SendGrid/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## SendGrid Email Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send email via the SendGrid API.
diff --git a/src/Senders/FluentEmail.Smtp/FluentEmail.Smtp.csproj b/src/Senders/FluentEmail.Smtp/FluentEmail.Smtp.csproj
@@ -15,4 +15,8 @@
     <ProjectReference Include="..\..\FluentEmail.Core\FluentEmail.Core.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Senders/FluentEmail.Smtp/README.md b/src/Senders/FluentEmail.Smtp/README.md
@@ -0,0 +1,7 @@
+![fluent email logo](https://raw.githubusercontent.com/lukencode/FluentEmail/master/assets/fluentemail_logo_64x64.png "FluentEmail")
+
+# FluentEmail - All in one email sender for .NET and .NET Core
+
+## SMTP Email Sender for [FluentEmail](https://github.com/jcamp-code/FluentEmail)
+
+Send email via DotNet's built-in `SmtpClient`.  Not recommended for production any more.
diff --git a/test/FluentEmail.Core.Tests/FluentEmail.Core.Tests.csproj b/test/FluentEmail.Core.Tests/FluentEmail.Core.Tests.csproj
@@ -30,13 +30,15 @@
     </None>
     <EmbeddedResource Include="EmailTemplates\test-embedded.txt" />
     <EmbeddedResource Include="test-embedded.txt" />
-    <PackageReference Include="FluentAssertions" Version="6.9.0" />
+    <PackageReference Include="FluentAssertions" Version="6.12.0" />
     <None Update="logotest.png">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Update="test-binary.xlsx">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <PackageReference Update="NUnit3TestAdapter" Version="4.5.0" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="17.8.0" />
   </ItemGroup>
 
 </Project>
diff --git a/test/FluentEmail.Liquid.Tests/FluentEmail.Liquid.Tests.csproj b/test/FluentEmail.Liquid.Tests/FluentEmail.Liquid.Tests.csproj
@@ -19,9 +19,11 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" Version="6.9.0" />
+    <PackageReference Include="FluentAssertions" Version="6.12.0" />
     <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="6.0.13" />
     <PackageReference Include="Microsoft.Extensions.FileProviders.Physical" Version="6.0.0" />
+    <PackageReference Update="NUnit3TestAdapter" Version="4.5.0" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="17.8.0" />
   </ItemGroup>
 
 </Project>
diff --git a/test/FluentEmail.Razor.Tests/FluentEmail.Razor.Tests.csproj b/test/FluentEmail.Razor.Tests/FluentEmail.Razor.Tests.csproj
@@ -27,4 +27,9 @@
     <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Update="NUnit3TestAdapter" Version="4.5.0" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+  </ItemGroup>
+
 </Project>