README.md in distribute_reads-0.4.0 vs README.md in distribute_reads-0.5.0
- old
+ new
@@ -2,11 +2,11 @@
Scale database reads to replicas in Rails
:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
-[![Build Status](https://github.com/ankane/distribute_reads/workflows/build/badge.svg?branch=master)](https://github.com/ankane/distribute_reads/actions)
+[![Build Status](https://github.com/ankane/distribute_reads/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/distribute_reads/actions)
## Installation
Add this line to your application’s Gemfile:
@@ -72,11 +72,11 @@
You can pass any options as well.
## Lazy Evaluation
-ActiveRecord uses [lazy evaluation](https://www.theodinproject.com/courses/ruby-on-rails/lessons/active-record-queries), which can delay the execution of a query to outside of a `distribute_reads` block. In this case, the primary will be used.
+Active Record uses [lazy evaluation](https://www.theodinproject.com/courses/ruby-on-rails/lessons/active-record-queries), which can delay the execution of a query to outside of a `distribute_reads` block. In this case, the primary will be used.
```ruby
users = distribute_reads { User.where(orders_count: 1) } # not executed yet
```
@@ -183,24 +183,24 @@
distribute_reads(replica: true) do
# send all queries in block to replica
end
```
-## Rails 6
+## Rails
-Rails 6 has [native support for replicas](https://guides.rubyonrails.org/active_record_multiple_databases.html) :tada:
+Rails 6+ has [native support for replicas](https://guides.rubyonrails.org/active_record_multiple_databases.html) :tada:
```ruby
ActiveRecord::Base.connected_to(role: :reading) do
# do reads
end
```
-However, it’s not able to automatically route queries like Makara just yet.
+However, it’s not able to do automatic statement-based routing like Makara yet.
## Thanks
-Thanks to [TaskRabbit](https://github.com/taskrabbit) for Makara, [Sherin Kurian](https://github.com/sherinkurian) for the max lag option, and [Nick Elser](https://github.com/nickelser) for the write-through cache.
+Thanks to [TaskRabbit](https://github.com/taskrabbit) for Makara, [Sherin Kurian](https://github.com/sherin) for the max lag option, and [Nick Elser](https://github.com/nickelser) for the write-through cache.
## History
View the [changelog](https://github.com/ankane/distribute_reads/blob/master/CHANGELOG.md)