Add PackageReadme (#730)

zzzprojects · Aug 6, 2023 · 381f0a0 · 381f0a0
1 parent 9737bcf
commit 381f0a0
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/PackageReadme.md b/PackageReadme.md
@@ -0,0 +1,22 @@
+## System.Linq.Dynamic.Core
+This is a **.NET Core / Standard port** of the Microsoft assembly for the .Net 4.0 Dynamic language functionality.
+
+### Overview
+With this library it's possible to write Dynamic LINQ queries (string based) on an `IQueryable`:
+``` c#
+var query = db.Customers
+    .Where("City == @0 and Orders.Count >= @1", "London", 10)
+    .OrderBy("CompanyName")
+    .Select("new(CompanyName as Name, Phone)");
+```
+
+### Useful links
+
+- [Website](https://dynamic-linq.net)
+- [Documentation](https://dynamic-linq.net/overview)
+- [Online examples](https://dynamic-linq.net/online-examples)
+
+
+### Library Powered By
+
+This library is powered by [Entity Framework Extensions](https://entityframework-extensions.net/?z=github&y=system.linq.dynamic.core)
diff --git a/System.Linq.Dynamic.Core.sln b/System.Linq.Dynamic.Core.sln
@@ -20,6 +20,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		Generate-ReleaseNotes.bat = Generate-ReleaseNotes.bat
 		LICENSE = LICENSE
 		NuGet.txt = NuGet.txt
+		PackageReadme.md = PackageReadme.md
 		README.md = README.md
 		report\run-coverlet-local.cmd = report\run-coverlet-local.cmd
 		version.xml = version.xml

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -10,6 +10,7 @@
         <LangVersion>11</LangVersion>
         <Nullable>enable</Nullable>
         <PackageIcon>logo.png</PackageIcon>
+        <PackageReadmeFile>PackageReadme.md</PackageReadmeFile>
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
         <PackageProjectUrl>https://dynamic-linq.net/</PackageProjectUrl>
         <PackageReleaseNotes>Bugfixes and new Features. For details see CHANGELOG.md</PackageReleaseNotes>
@@ -22,5 +23,6 @@
 
     <ItemGroup>
         <None Include="../../resources/logo.png" Pack="true" PackagePath="" />
+        <None Include="../../PackageReadme.md" Pack="true" PackagePath=""/>
     </ItemGroup>
 </Project>