👨‍🎨 Add logo to NuGet package

heytherewill · Nov 3, 2021 · 82308e6 · 82308e6
1 parent b9df425
commit 82308e6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/CookLangNet/CookLangNet.fsproj b/CookLangNet/CookLangNet.fsproj
@@ -5,21 +5,23 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
     <PackageId>CookLangNet</PackageId>
-    <PackageVersion>0.1.0</PackageVersion>
     <Authors>William Barbosa</Authors>
+    <PackageIcon>logo.png</PackageIcon>
     <Copyright>Copyright 2021</Copyright>
     <Description>Parser for CookLang.</Description>
     <PackageTags>cooklang;parser;fsharp</PackageTags>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageProjectUrl>https://github.com/heytherewill/cooklangnet</PackageProjectUrl>
     <PackageLicenseUrl>https://github.com/heytherewill/cooklangnet/blob/main/LICENSE</PackageLicenseUrl>
+    <PackageIconUrl>https://raw.githubusercontent.com/heytherewill/cooklangnet/main/cooklangnet/logo.png</PackageIconUrl>
   </PropertyGroup>
 
   <ItemGroup>
     <Compile Include="Utils.fs" />
     <Compile Include="Models.fs" />
     <Compile Include="Parser.fs" />
     <Compile Include="Api.fs" />
+    <None Include="logo.png" Pack="true" PackagePath="\"/>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/CookLangNet/logo.png b/CookLangNet/logo.png
diff --git a/README.md b/README.md
@@ -1,11 +1,13 @@
 ## 👨🏽‍🍳 CookLang parser for .NET 
 CookLangNet is simple and ergonomic parser for the [CookLang](https://cooklang.org/) spec written in F# for the .NET ecosystem.
+
 ## Installation
 ```terminal
 dotnet add package CookLangNet
 ```
 ## Usage
 Currently there's only one public API method, so consuming this library is as simple as calling `CookLangNet.ParseString` on the string representation of the recipe you want parsed.
+
 ## Contributing
 This project has CI health checks that run whenever you PR against the main branch. In order to ensure your contributions will behave correctly on CI, run the tests and the linter locally.
 Start by installing the linter tool, if you haven't:
@@ -16,4 +18,7 @@ Then to run the tests and the linter:
 ```
 dotnet test
 dotnet fsharplint lint .\CookLangNet.sln
-```
+```
+
+## Credits
+[Cook](https://thenounproject.com/search/?q=cook&i=4362574) by [Jino](https://thenounproject.com/microdotgraphic/) from [the Noun Project](https://thenounproject.com/)