readme + icon

templateless · Feb 14, 2024 · 33d9931 · 33d9931
1 parent fea5e34
commit 33d9931
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# CHANGELOG
+
+**Unpublished:**
+- Introduced CHANGELOG
+- Added `icon.png` to `PackageIcon`
+
+**v0.1.1:**
+- Initial implementation
diff --git a/NUGET-README.md b/NUGET-README.md
@@ -58,8 +58,8 @@ class Program
                 .Content(content)
                 .Build();
 
-            var templatelessClient = new TemplatelessClient("<YOUR_API_KEY>");
-            var emailIds = await templatelessClient.SendEmailAsync(email);
+            var templateless = new TemplatelessClient("<YOUR_API_KEY>");
+            var emailIds = await templateless.SendEmailAsync(email);
 
             Console.WriteLine(string.Join(", ", emailIds));
         }

diff --git a/README.md b/README.md
@@ -1,12 +1,28 @@
-# Templateless .NET (C#)
+<h1 align="center">
+  <a href="https://templateless.com/">
+    <img src="templateless.webp" alt="Templateless" width="450px">
+  </a>
+  <br />
+</h1>
+
+<p align="center">
+  <b>Ship faster by treating email as code 🚀</b> <br />
+</p>
+
+<h4 align="center">
+  <a href="https://templateless.com/">Website</a> &bull;
+  <a href="https://app.templateless.com/">Get Your API Key</a> &bull;
+  <a href="https://twitter.com/templateless">Twitter</a>
+</h4>
+
+---
 
 [![Latest version](https://img.shields.io/nuget/v/Templateless)](https://www.nuget.org/packages/Templateless)
 [![Github Actions](https://img.shields.io/github/actions/workflow/status/templateless/templateless-dotnet/tests.yml)](https://github.com/templateless/templateless-dotnet/actions)
 [![Downloads](https://img.shields.io/nuget/dt/Templateless)](https://www.nuget.org/packages/Templateless)
+[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/Templateless)](https://twitter.com/templateless)
 
-## What is Templateless?
-
-[Templateless](https://templateless.com) lets you generate and send transactional emails quickly and easily so you can ship faster 🚀
+[Templateless](https://templateless.com) lets you generate and send transactional emails quickly and easily so you can focus on building your product.
 
 ## ✨ Features
 
@@ -58,8 +74,8 @@ class Program
                 .Content(content)
                 .Build();
 
-            var templatelessClient = new TemplatelessClient("<YOUR_API_KEY>");
-            var emailIds = await templatelessClient.SendEmailAsync(email);
+            var templateless = new TemplatelessClient("<YOUR_API_KEY>");
+            var emailIds = await templateless.SendEmailAsync(email);
 
             Console.WriteLine(string.Join(", ", emailIds));
         }
@@ -75,7 +91,10 @@ class Program
 }
 ```
 
-Note:
+> **Note**
+> 🚧 **This SDK is not stable yet.** The API might change as more features are added. Please pay attention to the [CHANGELOG](CHANGELOG.md) for breaking changes.
+
+Examples:
 
 1. Get your **free API key** here: <https://app.templateless.com> ✨
 1. There are more C# examples in the [examples](examples) folder:

diff --git a/examples/ConfirmEmailExample/Program.cs b/examples/ConfirmEmailExample/Program.cs
@@ -50,8 +50,8 @@ static async Task Main(string[] args)
                     .Content(content)
                     .Build();
 
-                var templatelessClient = new TemplatelessClient(apiKey);
-                var emailIds = await templatelessClient.SendEmailAsync(email);
+                var templateless = new TemplatelessClient(apiKey);
+                var emailIds = await templateless.SendEmailAsync(email);
 
                 Console.WriteLine(string.Join(", ", emailIds));
             }

diff --git a/examples/SimpleExample/Program.cs b/examples/SimpleExample/Program.cs
@@ -32,8 +32,8 @@ static async Task Main(string[] args)
 					.Content(content)
 					.Build();
 
-				var templatelessClient = new TemplatelessClient(apiKey);
-				var emailIds = await templatelessClient.SendEmailAsync(email);
+				var templateless = new TemplatelessClient(apiKey);
+				var emailIds = await templateless.SendEmailAsync(email);
 
 				Console.WriteLine(string.Join(", ", emailIds));
 			}

diff --git a/icon.png b/icon.png
diff --git a/src/Templateless/Templateless.csproj b/src/Templateless/Templateless.csproj
@@ -11,8 +11,8 @@
 		<Version>0.1.1</Version>
 		<Description>Ship faster by sending elegant emails using just code</Description>
 		<PackageTags>Templateless;email;templates</PackageTags>
-		<PackageIconUrl></PackageIconUrl>
-		<PackageIcon></PackageIcon>
+		<PackageIconUrl>https://raw.githubusercontent.com/templateless/templateless-dotnet/main/icon.png</PackageIconUrl>
+		<PackageIcon>icon.png</PackageIcon>
 		<PackageReleaseNotes>https://github.com/templateless/templateless-dotnet/releases</PackageReleaseNotes>
 		<PackageReadmeFile>nuget-readme.md</PackageReadmeFile>
 		<PackageProjectUrl>https://templateless.com</PackageProjectUrl>
@@ -32,7 +32,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<!-- <None Include="..\..\icon.png" Pack="true" PackagePath="" /> -->
+		<None Include="..\..\icon.png" Pack="true" PackagePath="" />
 		<None Include="..\..\nuget-readme.md" Pack="true" PackagePath="\" />
 	</ItemGroup>
 

diff --git a/templateless.webp b/templateless.webp