fix(packaging): add icon and nuget-specific readme

Author: erlendellefsen

JsonApiToolkit/JsonApiToolkit.csproj

@@ -6,15 +6,18 @@
 
     <!-- Package metadata -->
     <PackageId>Intility.JsonApiToolkit</PackageId>
+    <Title>JsonApiToolkit</Title>
     <Version>2.1.2</Version>
     <Authors>Intility</Authors>
     <Company>Intility</Company>
+    <Copyright>Copyright (c) Intility</Copyright>
     <Description>Build JSON:API endpoints in ASP.NET Core. Translates JSON:API query parameters (filter, sort, include, fields, page) into typed EF Core queries and returns spec-compliant response documents.</Description>
     <PackageTags>jsonapi;json-api;aspnetcore;efcore;rest;api;dotnet</PackageTags>
     <RepositoryUrl>https://github.com/intility/json-api-toolkit</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageProjectUrl>https://github.com/intility/json-api-toolkit</PackageProjectUrl>
-    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageIcon>intility-logo.png</PackageIcon>
+    <PackageReadmeFile>README.nuget.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
 
     <!-- Generate XML documentation -->
@@ -30,6 +33,7 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="10.0.7"/>
   </ItemGroup>
   <ItemGroup>
-    <None Include="..\README.md" Pack="true" PackagePath="\"/>
+    <None Include="..\README.nuget.md" Pack="true" PackagePath="\" />
+    <None Include="..\assets\intility-logo.png" Pack="true" Visible="false" PackagePath="\" />
   </ItemGroup>
 </Project>

README.nuget.md

@@ -0,0 +1,47 @@
+# JsonApiToolkit
+
+Build [JSON:API](https://jsonapi.org/) endpoints in ASP.NET Core. Translates JSON:API query parameters (`filter[]`, `sort`, `include`, `fields[]`, `page[]`) into typed EF Core queries and shapes responses as spec-compliant documents, so your controllers stay short.
+
+## Install
+
+```sh
+dotnet add package Intility.JsonApiToolkit
+```
+
+## Quick example
+
+Register in `Program.cs`:
+
+```csharp
+builder.Services.AddJsonApiToolkit();
+```
+
+Derive controllers from `JsonApiController`:
+
+```csharp
+public class BooksController : JsonApiController
+{
+    private const string ResourceType = "book";
+
+    [HttpGet]
+    public async Task<IActionResult> GetAllAsync()
+    {
+        return await JsonApiQueryAsync(_db.Books, ResourceType);
+    }
+}
+```
+
+Then call with JSON:API query parameters:
+
+```
+GET /api/books?filter[title]=Hobbit&include=author&fields[book]=title&page[size]=10&sort=-published
+```
+
+Filtering, sorting, includes, sparse fieldsets, and pagination all work without extra code.
+
+## Links
+
+- **Documentation**: <https://intility.github.io/json-api-toolkit/>
+- **Source**: <https://github.com/intility/json-api-toolkit>
+- **Issues**: <https://github.com/intility/json-api-toolkit/issues>
+- **License**: MIT