Skip to content

Commit 28ca7d5

Browse files
committed
Add readme to NuGet packages
1 parent c6584b6 commit 28ca7d5

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

PackageReadme.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
A framework for building [JSON:API](http://jsonapi.org/) compliant REST APIs using .NET Core and Entity Framework Core. Includes support for [Atomic Operations](https://jsonapi.org/ext/atomic/).
2+
3+
The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection, making extensibility incredibly easy.
4+
5+
For more information, visit [www.jsonapi.net](https://www.jsonapi.net/).

src/JsonApiDotNetCore.Annotations/JsonApiDotNetCore.Annotations.csproj

+3-4
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@
1717
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
1818
<PackageReleaseNotes>See https://github.com/json-api-dotnet/JsonApiDotNetCore/releases.</PackageReleaseNotes>
1919
<PackageIcon>logo.png</PackageIcon>
20+
<PackageReadmeFile>PackageReadme.md</PackageReadmeFile>
2021
<PublishRepositoryUrl>true</PublishRepositoryUrl>
2122
<EmbedUntrackedSources>true</EmbedUntrackedSources>
2223
<DebugType>embedded</DebugType>
2324
</PropertyGroup>
2425

2526
<ItemGroup>
26-
<None Include="..\..\logo.png" Visible="false">
27-
<Pack>True</Pack>
28-
<PackagePath></PackagePath>
29-
</None>
27+
<None Include="..\..\logo.png" Visible="false" Pack="True" PackagePath="" />
28+
<None Include="..\..\PackageReadme.md" Visible="false" Pack="True" PackagePath="" />
3029
</ItemGroup>
3130

3231
<!-- We multi-target against NetStandard solely to enable consumers to share their models project with .NET Framework code. -->

src/JsonApiDotNetCore.SourceGenerators/JsonApiDotNetCore.SourceGenerators.csproj

+3-4
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,13 @@
1919
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
2020
<PackageReleaseNotes>See https://github.com/json-api-dotnet/JsonApiDotNetCore/releases.</PackageReleaseNotes>
2121
<PackageIcon>logo.png</PackageIcon>
22+
<PackageReadmeFile>PackageReadme.md</PackageReadmeFile>
2223
<RepositoryUrl>https://github.com/json-api-dotnet/JsonApiDotNetCore</RepositoryUrl>
2324
</PropertyGroup>
2425

2526
<ItemGroup>
26-
<None Include="..\..\logo.png" Visible="false">
27-
<Pack>True</Pack>
28-
<PackagePath></PackagePath>
29-
</None>
27+
<None Include="..\..\logo.png" Visible="false" Pack="True" PackagePath="" />
28+
<None Include="..\..\PackageReadme.md" Visible="false" Pack="True" PackagePath="" />
3029
</ItemGroup>
3130

3231
<ItemGroup>

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

+3-4
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,15 @@
1515
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
1616
<PackageReleaseNotes>See https://github.com/json-api-dotnet/JsonApiDotNetCore/releases.</PackageReleaseNotes>
1717
<PackageIcon>logo.png</PackageIcon>
18+
<PackageReadmeFile>PackageReadme.md</PackageReadmeFile>
1819
<PublishRepositoryUrl>true</PublishRepositoryUrl>
1920
<EmbedUntrackedSources>true</EmbedUntrackedSources>
2021
<DebugType>embedded</DebugType>
2122
</PropertyGroup>
2223

2324
<ItemGroup>
24-
<None Include="..\..\logo.png" Visible="false">
25-
<Pack>True</Pack>
26-
<PackagePath></PackagePath>
27-
</None>
25+
<None Include="..\..\logo.png" Visible="false" Pack="True" PackagePath="" />
26+
<None Include="..\..\PackageReadme.md" Visible="false" Pack="True" PackagePath="" />
2827
</ItemGroup>
2928

3029
<ItemGroup>

0 commit comments

Comments
 (0)