Skip to content

Commit 5473ded

Browse files
authored
docs: Update README and gem description to match new positioning (#120)
1 parent 457de24 commit 5473ded

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
<!-- ParadeDB: Postgres for Search and Analytics -->
21
<h1 align="center">
3-
<a href="https://paradedb.com"><img src="https://github.com/paradedb/paradedb/raw/main/docs/logo/readme.svg" alt="ParadeDB"></a>
4-
<br>
2+
<a href="https://paradedb.com">
3+
<picture align=center>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/paradedb/paradedb/raw/main/docs/logo/paradedb-logo-dark-large.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="https://github.com/paradedb/paradedb/raw/main/docs/logo/paradedb-logo-light-large.svg">
6+
<img alt="The ParadeDB logo." src="https://github.com/paradedb/paradedb/raw/main/docs/logo/paradedb-logo-light-large.svg">
7+
</picture>
8+
</a>
9+
<br>
510
</h1>
611

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

1117
<h3 align="center">
@@ -30,7 +36,7 @@
3036

3137
## ParadeDB for Rails
3238

33-
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.
39+
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.
3440

3541
## Requirements & Compatibility
3642

rails-paradedb.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
99
spec.email = ["support@paradedb.com"]
1010

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

0 commit comments

Comments
 (0)