chore: Add NuGet version of README (#76)

Author: isaacvando

CHANGELOG.md

@@ -4,10 +4,17 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [0.1.1] - 2025-06-01
+
+## Added
+
+- Added a dedicated README that can be properly rendered on NuGet.
+
 ## [0.1.0] - 2025-06-01
 
 ### Added
 
 - Support for the ParadeDB query language, index management, and diagnostics.
 
+[0.1.1]: https://github.com/paradedb/efcore-paradedb/releases/tag/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/paradedb/efcore-paradedb/releases/tag/v0.1.0

NUGET-README.md

@@ -0,0 +1,48 @@
+# ParadeDB for Entity Framework Core
+
+The official [Entity Framework Core](https://learn.microsoft.com/en-us/ef/core/) integration for [ParadeDB](https://paradedb.com), including first-class support for managing BM25 indexes and running queries using the full ParadeDB API. Follow the [getting started guide](https://docs.paradedb.com/documentation/getting-started/environment#entity-framework-core) to begin.
+
+## Requirements & Compatibility
+
+| Component  | Supported                     |
+| ---------- | ----------------------------- |
+| .NET       | 8.0+                          |
+| EF Core    | 8.0+                          |
+| ParadeDB   | 0.23.0+                       |
+| PostgreSQL | 15+ (with ParadeDB extension) |
+
+## Examples
+
+- [Quickstart](examples/Quickstart/Program.cs)
+- [Faceted Search](examples/FacetedSearch/Program.cs)
+- [Autocomplete](examples/Autocomplete/Program.cs)
+- [More Like This](examples/MoreLikeThis/Program.cs)
+- [Hybrid Search (RRF)](examples/HybridRrf/Program.cs)
+- [RAG](examples/Rag/Program.cs)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, running tests, linting, and the PR workflow.
+
+## Support
+
+If you're missing a feature or have found a bug, please open a
+[GitHub Issue](https://github.com/paradedb/efcore-paradedb/issues/new/choose).
+
+To get community support, you can:
+
+- Post a question in the [ParadeDB Slack Community](https://paradedb.com/slack)
+- Ask for help on our [GitHub Discussions](https://github.com/paradedb/paradedb/discussions)
+
+If you need commercial support, please [contact the ParadeDB team](mailto:sales@paradedb.com).
+
+## Acknowledgments
+
+We would like to thank the following members of the Entity Framework Core community:
+
+- [Nandor Krizbai](https://github.com/nandor23) - for the initial implementation of this project
+- [Daniel Oliveira](https://github.com/daniel3303) - for implementing [ParadeDbEntityFrameworkCore](https://github.com/daniel3303/ParadeDbEntityFrameworkCore) which inspired our indexing implementation
+
+## License
+
+ParadeDB for Entity Framework Core is licensed under the [MIT License](LICENSE).

src/Directory.Build.props

@@ -11,7 +11,7 @@
     <Copyright>Copyright (c) ParadeDB, Inc.</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
-    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageReadmeFile>NUGET-README.md</PackageReadmeFile>
     <PackageIcon>paradedb-logo.png</PackageIcon>
     <PackageProjectUrl>https://github.com/paradedb/efcore-paradedb</PackageProjectUrl>
     <RepositoryUrl>https://github.com/paradedb/efcore-paradedb</RepositoryUrl>
@@ -21,7 +21,7 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
   <ItemGroup>
-    <None Include="..\README.md" Pack="true" PackagePath="\" />
+    <None Include="..\NUGET-README.md" Pack="true" PackagePath="\" />
     <None Include="..\LICENSE" Pack="true" PackagePath="\" />
     <None Include="..\assets\paradedb-logo.png" Pack="true" PackagePath="\" />
   </ItemGroup>