Commit 67239decb8f1f2bef1416c535ac80d7079103e2c
1 parent
f1d19a90
Exists in
master
and in
2 other branches
Started upgrading section [skip ci]
Showing
1 changed file
with
14 additions
and
0 deletions
Show diff stats
README.md
... | ... | @@ -43,6 +43,8 @@ Check out [Searchjoy](https://github.com/ankane/searchjoy) for analytics and [Au |
43 | 43 | - [Reference](#reference) |
44 | 44 | - [Contributing](#contributing) |
45 | 45 | |
46 | +**Searchkick 5.0 was recently released!** See [how to upgrade](#upgrading) | |
47 | + | |
46 | 48 | ## Getting Started |
47 | 49 | |
48 | 50 | Install [OpenSearch](https://opensearch.org/downloads.html) or [Elasticsearch](https://www.elastic.co/downloads/elasticsearch). For Homebrew, use: |
... | ... | @@ -2039,6 +2041,18 @@ end |
2039 | 2041 | |
2040 | 2042 | For convenience, this is set by default in the test environment. |
2041 | 2043 | |
2044 | +## Upgrading | |
2045 | + | |
2046 | +### 5.0 | |
2047 | + | |
2048 | +Searchkick 5 supports both the `opensearch-ruby` and `elasticsearch` gems. Add the one you want to use to your Gemfile: | |
2049 | + | |
2050 | +```ruby | |
2051 | +gem "elasticsearch" | |
2052 | +``` | |
2053 | + | |
2054 | +If using the deprecated `faraday_middleware-aws-signers-v4` gem, switch to `faraday_middleware-aws-sigv4`. | |
2055 | + | |
2042 | 2056 | ## History |
2043 | 2057 | |
2044 | 2058 | View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md). | ... | ... |