Skip to content

docs: standardize README to match other ParadeDB ORM repos - #35

Merged
philippemnoel merged 1 commit into
mainfrom
chore/standardize-readme
May 12, 2026
Merged

docs: standardize README to match other ParadeDB ORM repos#35
philippemnoel merged 1 commit into
mainfrom
chore/standardize-readme

Conversation

@philippemnoel

Copy link
Copy Markdown
Member

Summary

Brings the efcore-paradedb README in line with the format used by django-paradedb, sqlalchemy-paradedb, and rails-paradedb so the ORM family presents consistently.

Header / branding

  • Replace the local assets/paradedb-logo.png heading with the canonical ParadeDB readme SVG hosted in paradedb/paradedb.
  • Add the standard tagline ("Simple, Elastic-quality search for Postgres") and top nav row (Website / Docs / Community / Blog / Changelog).
  • Replace the previous ad-hoc badge row with the standard one: NuGet version, .NET version range, NuGet downloads, Codecov, License, Slack, Twitter.

Body

  • Switch to the "## ParadeDB for Entity Framework Core" intro pattern with a single short paragraph linking to the docs getting-started anchor (#efcore).
  • Add an EF Core row to the Requirements & Compatibility table.
  • Drop the Configuration code snippet and Function Mappings table — neither of the sibling ORM READMEs has these. The Function Mappings table stays in NUGET-README.md (the package page), and configuration details belong on docs.paradedb.com.
  • Keep the Examples list, Contributing, Support, Acknowledgments (Nandor Krizbai), and License sections.

Notes / follow-ups not in this PR

  • The Codecov badge will display "unknown" until coverage upload is wired up (no .NET coverage step in ci.yml yet).
  • The docs anchor #efcore on docs.paradedb.com/documentation/getting-started/environment may not exist yet; matches the convention used by the other ORMs (#django, #sqlalchemy, #rails). Update if the canonical anchor differs.
  • assets/paradedb-logo.png is now unreferenced by the README but kept on disk — it's still packed into the NuGet package via src/Directory.Build.props (<PackageIcon>paradedb-logo.png</PackageIcon>).

Test plan

Match the format used by django-paradedb, sqlalchemy-paradedb, and
rails-paradedb so the ParadeDB ORM family presents consistently:

- Replace the local logo (assets/paradedb-logo.png) with the canonical
  ParadeDB readme SVG hosted in paradedb/paradedb.
- Add the tagline, top nav (Website / Docs / Community / Blog /
  Changelog), and the standard badge row (NuGet version, .NET versions,
  NuGet downloads, Codecov, License, Slack, Twitter).
- Switch the intro to the "ParadeDB for X" pattern with a single
  paragraph that links to the docs getting-started anchor.
- Drop the Configuration code snippet and Function Mappings table from
  the README — keep the README short and link to docs; the Function
  Mappings table is still in NUGET-README.md for the package page.
- Update Requirements & Compatibility table to add EF Core row.
@philippemnoel
philippemnoel merged commit 4e5ac4f into main May 12, 2026
9 checks passed
@philippemnoel
philippemnoel deleted the chore/standardize-readme branch May 12, 2026 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant