📝

hlaueriksson · Apr 11, 2022 · f51aa31 · f51aa31
1 parent 135211d
commit f51aa31
Show file tree

Hide file tree

Showing 6 changed files with 141 additions and 7 deletions.
diff --git a/GEmojiSharp.AspNetCore.md b/GEmojiSharp.AspNetCore.md
@@ -0,0 +1,61 @@
+# GEmojiSharp.AspNetCore 📦
+
+[![Build status](https://github.com/hlaueriksson/GEmojiSharp/workflows/build/badge.svg)](https://github.com/hlaueriksson/GEmojiSharp/actions?query=workflow%3Abuild) [![CodeFactor](https://www.codefactor.io/repository/github/hlaueriksson/gemojisharp/badge)](https://www.codefactor.io/repository/github/hlaueriksson/gemojisharp)
+
+> GitHub Emoji for ASP.NET Core
+
+The package includes:
+
+- TagHelpers
+- HtmlHelpers
+
+## TagHelpers
+
+Update the `_ViewImports.cshtml` file, to enable tag helpers in all Razor views:
+
+```cshtml
+@addTagHelper *, GEmojiSharp.AspNetCore
+```
+
+Use the `<emoji>` tag or `emoji` attribute to render emojis:
+
+```html
+<span emoji=":tada:"></span>
+<emoji>:tada: initial commit</emoji>
+```
+
+Do you want to use emoji anywhere, on any tag, in the `body`? Then you can use the `BodyTagHelperComponent`.
+
+Registration via services container:
+
+```cs
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services.AddRazorPages();
+builder.Services.AddTransient<ITagHelperComponent, BodyTagHelperComponent>();
+```
+
+Use any tag to render emojis:
+
+```html
+<h1>Hello, :earth_africa:</h1>
+```
+
+## HtmlHelpers
+
+Update the `_ViewImports.cshtml` file, to enable HTML helpers in all Razor views:
+
+```cshtml
+@using GEmojiSharp.AspNetCore
+```
+
+Use the `Emoji` extension methods to render emojis:
+
+```cshtml
+@Html.Emoji(":tada: initial commit")
+@Html.Emoji(x => x.Text)
+```
+
+## Would you like to know more? 🤔
+
+Further documentation is available at [https://github.com/hlaueriksson/GEmojiSharp](https://github.com/hlaueriksson/GEmojiSharp)
diff --git a/GEmojiSharp.Blazor.md b/GEmojiSharp.Blazor.md
@@ -0,0 +1,23 @@
+# GEmojiSharp.Blazor 📦
+
+[![Build status](https://github.com/hlaueriksson/GEmojiSharp/workflows/build/badge.svg)](https://github.com/hlaueriksson/GEmojiSharp/actions?query=workflow%3Abuild) [![CodeFactor](https://www.codefactor.io/repository/github/hlaueriksson/gemojisharp/badge)](https://www.codefactor.io/repository/github/hlaueriksson/gemojisharp)
+
+> GitHub Emoji for Blazor
+
+The package is a Razor class library (RCL) with a Razor component.
+
+Update the `_Imports.razor` file, to enable the component in all Razor views:
+
+```cshtml
+@using GEmojiSharp.Blazor
+```
+
+Use the `<Emoji>` component to render emojis:
+
+```html
+<Emoji>:tada: initial commit</Emoji>
+```
+
+## Would you like to know more? 🤔
+
+Further documentation is available at [https://github.com/hlaueriksson/GEmojiSharp](https://github.com/hlaueriksson/GEmojiSharp)
diff --git a/GEmojiSharp.md b/GEmojiSharp.md
@@ -0,0 +1,44 @@
+# GEmojiSharp 📦
+
+[![Build status](https://github.com/hlaueriksson/GEmojiSharp/workflows/build/badge.svg)](https://github.com/hlaueriksson/GEmojiSharp/actions?query=workflow%3Abuild) [![CodeFactor](https://www.codefactor.io/repository/github/hlaueriksson/gemojisharp/badge)](https://www.codefactor.io/repository/github/hlaueriksson/gemojisharp)
+
+> GitHub Emoji for C# and .NET
+
+Static methods:
+
+```csharp
+Emoji.Get(":tada:").Raw; // 🎉
+Emoji.Get("🎉").Alias(); // :tada:
+Emoji.Raw(":tada:"); // 🎉
+Emoji.Alias("🎉"); // :tada:
+Emoji.Emojify(":tada: initial commit"); // 🎉 initial commit
+Emoji.Demojify("🎉 initial commit"); // :tada: initial commit
+Emoji.Find("party popper").First().Raw; // 🎉
+```
+
+Extension methods:
+
+```csharp
+":tada:".GetEmoji().Raw; // 🎉
+"🎉".GetEmoji().Alias(); // :tada:
+":tada:".RawEmoji(); // 🎉
+"🎉".EmojiAlias(); // :tada:
+":tada: initial commit".Emojify(); // 🎉 initial commit
+"🎉 initial commit".Demojify(); // :tada: initial commit
+"party popper".FindEmojis().First().Raw; // 🎉
+```
+
+Regular expression pattern to match all emojis:
+
+```csharp
+var text = "Lorem 😂😂 ipsum";
+
+var matches = Regex.Matches(text, Emoji.RegexPattern);
+string.Join(string.Empty, matches.Select(x => x.Value)); // 😂😂
+
+Regex.Replace(text, Emoji.RegexPattern, string.Empty); // Lorem  ipsum
+```
+
+## Would you like to know more? 🤔
+
+Further documentation is available at [https://github.com/hlaueriksson/GEmojiSharp](https://github.com/hlaueriksson/GEmojiSharp)
diff --git a/src/GEmojiSharp.AspNetCore/GEmojiSharp.AspNetCore.csproj b/src/GEmojiSharp.AspNetCore/GEmojiSharp.AspNetCore.csproj
@@ -19,6 +19,7 @@
     <PackageId>GEmojiSharp.AspNetCore</PackageId>
     <PackageProjectUrl>https://github.com/hlaueriksson/GEmojiSharp</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
+    <PackageReadmeFile>GEmojiSharp.AspNetCore.md</PackageReadmeFile>
     <PackageTags>emoji;gemoji;aspnetcore;aspnetcoremvc;taghelper;taghelpers;htmlhelper;htmlhelpers</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -28,6 +29,7 @@
 
   <ItemGroup>
     <None Include="..\..\icon.png" Link="icon.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\GEmojiSharp.AspNetCore.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/GEmojiSharp.Blazor/GEmojiSharp.Blazor.csproj b/src/GEmojiSharp.Blazor/GEmojiSharp.Blazor.csproj
@@ -19,6 +19,7 @@
     <PackageId>GEmojiSharp.Blazor</PackageId>
     <PackageProjectUrl>https://github.com/hlaueriksson/GEmojiSharp</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
+    <PackageReadmeFile>GEmojiSharp.Blazor.md</PackageReadmeFile>
     <PackageTags>emoji;gemoji;blazor;component;rcl</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -32,6 +33,7 @@
 
   <ItemGroup>
     <None Include="..\..\icon.png" Link="icon.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\GEmojiSharp.Blazor.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/GEmojiSharp/GEmojiSharp.csproj b/src/GEmojiSharp/GEmojiSharp.csproj
@@ -4,13 +4,13 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <Version>2.0.0</Version>
     <PackageReleaseNotes>
-- New:
- - Emoji.Alias("😀") // :grinning:
- - Emoji.Demojify("Hello, 🌍") // Hello, :earth_africa:
- - Emoji.RegexPattern // Regular expression pattern to match all supported emojis
-- Update:
- - Emoji.Get("😀") // By raw emoji
- - Emoji.Find(":grinning:") // Query for alias enclosed by colons
+New:
+- Emoji.Alias("😀") // :grinning:
+- Emoji.Demojify("Hello, 🌍") // Hello, :earth_africa:
+- Emoji.RegexPattern // Regular expression pattern to match all supported emojis
+Updated:
+- Emoji.Get("😀") // By raw emoji
+- Emoji.Find(":grinning:") // Query for alias enclosed by colons
     </PackageReleaseNotes>
     <Authors>Henrik Lau Eriksson</Authors>
     <Description>GitHub Emoji for C# and .NET
@@ -24,6 +24,7 @@
     <PackageId>GEmojiSharp</PackageId>
     <PackageProjectUrl>https://github.com/hlaueriksson/GEmojiSharp</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
+    <PackageReadmeFile>GEmojiSharp.md</PackageReadmeFile>
     <PackageTags>emoji;gemoji</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -33,6 +34,7 @@
 
   <ItemGroup>
     <None Include="..\..\icon.png" Link="icon.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\GEmojiSharp.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>