Skip to content

docs: Update README and gem description to match new positioning #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philippemnoel merged 4 commits into from
Jul 14, 2026
+12 −6
Merged

docs: Update README and gem description to match new positioning #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
67c36cc
docs: Update README and gem description to match new positioning
jamessewell Jul 13, 2026
d3b2853
docs: Remove positioning comment from README
jamessewell Jul 14, 2026
252d437
docs: Introduce pg_search in its own sentence
jamessewell Jul 14, 2026
2324d10
docs: Minimize pg_search mention to a parenthetical
jamessewell Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
<!-- ParadeDB: Postgres for Search and Analytics -->
<h1 align="center">
<a href="https://paradedb.com"><img src="https://github.com/paradedb/paradedb/raw/main/docs/logo/readme.svg" alt="ParadeDB"></a>
<br>
<a href="https://paradedb.com">
<picture align=center>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/paradedb/paradedb/raw/main/docs/logo/paradedb-logo-dark-large.svg">
Comment thread
philippemnoel marked this conversation as resolved.
<source media="(prefers-color-scheme: light)" srcset="https://github.com/paradedb/paradedb/raw/main/docs/logo/paradedb-logo-light-large.svg">
<img alt="The ParadeDB logo." src="https://github.com/paradedb/paradedb/raw/main/docs/logo/paradedb-logo-light-large.svg">
</picture>
</a>
<br>
</h1>

<p align="center">
<b>Simple, Elastic-quality search for Postgres</b><br/>
<b>Search without a second system.</b><br/>
One Postgres for your application data, full-text search, vector retrieval, and aggregations.
</p>

<h3 align="center">
Expand All @@ -30,7 +36,7 @@

## ParadeDB for Rails

The official ActiveRecord 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#rails) to begin.
The official ActiveRecord integration for [ParadeDB](https://paradedb.com) (powered by the [`pg_search`](https://github.com/paradedb/paradedb) Postgres extension), 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#rails) to begin.

## Requirements & Compatibility

Expand Down
2 changes: 1 addition & 1 deletion rails-paradedb.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
spec.email = ["support@paradedb.com"]

spec.summary = "ParadeDB integration for ActiveRecord"
spec.description = "Simple, Elastic-quality search for Postgres via ParadeDB and ActiveRecord."
spec.description = "Elastic-quality full-text search, vector retrieval, and aggregations in Postgres via ParadeDB and ActiveRecord."
spec.homepage = "https://github.com/paradedb/rails-paradedb"
spec.license = "MIT"
spec.required_ruby_version = ">= 3.2"
Expand Down
Loading