Skip to content

Commit

Permalink
update readme and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
BuonOmo committed Sep 24, 2024
1 parent 8c5cca5 commit 1df22ac
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# ActiveRecord CockroachDB Adapter

CockroachDB adapter for ActiveRecord 5, 6, and 7. This is a lightweight extension of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).
CockroachDB adapter for ActiveRecord. This is a lightweight extension
of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).

## Installation

Add this line to your project's Gemfile:

```ruby
gem 'activerecord-cockroachdb-adapter', '~> 7.0.0'
gem 'activerecord-cockroachdb-adapter', '~> 7.2.0'
```

If you're using Rails 5.2, use the `5.2.x` versions of this gem.
If you're using Rails 7.0, use the `7.0.x` versions of this gem.

If you're using Rails 6.0, use the `6.0.x` versions of this gem.
If you're using Rails 7.1, use the `7.1.x` versions of this gem.

If you're using Rails 7.0, use the `7.0.x` versions of this gem.
If you're using Rails 7.2, use the `7.2.x` versions of this gem.
The minimal CockroachDB version required is 23.1.12 for this version.

In `database.yml`, use the following adapter setting:

Expand Down
2 changes: 1 addition & 1 deletion lib/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
# limitations under the License.

module ActiveRecord
COCKROACH_DB_ADAPTER_VERSION = "7.1.1"
COCKROACH_DB_ADAPTER_VERSION = "7.2.0"
end

0 comments on commit 1df22ac

Please sign in to comment.