Skip to content

Commit f4e1004

Browse files
docs: shorten README tagline and use "X+" version format (#37)
1 parent 8be9535 commit f4e1004

3 files changed

Lines changed: 12 additions & 8 deletions

File tree

NUGET-README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ BM25 index creation must be defined using raw SQL. See the [EF Core documentatio
1212

1313
| Component | Supported |
1414
| ---------- | ----------------------------- |
15-
| .NET | 8, 9, 10 |
16-
| ParadeDB | 0.23.0+ |
15+
| .NET | 8+ |
16+
| EF Core | 8+ |
17+
| ParadeDB | 0.22.0+ |
1718
| PostgreSQL | 15+ (with ParadeDB extension) |
1819

1920
## Configuration

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,20 @@
2828

2929
---
3030

31+
> [!NOTE]
32+
> `efcore-paradedb` is a work in progress and is not yet recommended for production use. APIs may evolve as we stabilize the integration — pin to an exact version if you're trying it out.
33+
3134
## ParadeDB for Entity Framework Core
3235

33-
The official [Entity Framework Core](https://learn.microsoft.com/en-us/ef/core/) integration for [ParadeDB](https://paradedb.com), built on top of [Npgsql.EntityFrameworkCore.PostgreSQL](https://www.npgsql.org/efcore/index.html), exposing ParadeDB search functions through the `EF.Functions` API for LINQ-based full-text search queries. Follow the [getting started guide](https://docs.paradedb.com/documentation/getting-started/environment#efcore) to begin.
36+
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#efcore) to begin.
3437

3538
## Requirements & Compatibility
3639

3740
| Component | Supported |
3841
| ---------- | ----------------------------- |
39-
| .NET | 8, 9, 10 |
40-
| EF Core | 8, 9, 10 |
41-
| ParadeDB | 0.23.0+ |
42+
| .NET | 8+ |
43+
| EF Core | 8+ |
44+
| ParadeDB | 0.22.0+ |
4245
| PostgreSQL | 15+ (with ParadeDB extension) |
4346

4447
## Examples

RELEASE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ GitHub release do not already exist.
4545
The canonical support matrix lives in `README.md` under
4646
**Requirements & Compatibility** and should be kept up to date.
4747

48-
Today, the maintained minimum ParadeDB version is `0.23.0`. Update the README
48+
Today, the maintained minimum ParadeDB version is `0.22.0`. Update the README
4949
matrix, CI image tags, and any version-gated examples in the same PR whenever
5050
that floor changes.
5151

@@ -54,7 +54,7 @@ that floor changes.
5454
- .NET: 8, 9, 10
5555
- Entity Framework Core: via Npgsql.EntityFrameworkCore.PostgreSQL
5656
- PostgreSQL: 15+ with the ParadeDB extension
57-
- ParadeDB: 0.23.0+
57+
- ParadeDB: 0.22.0+
5858

5959
## Pre-Release Checklist
6060

0 commit comments

Comments
 (0)