Skip to content

Commit 3cc92cd

Browse files
committed
Added the "Compatibility" chapter to the READMEs
In order to make the support for different Elasticsearch versions more clear, a special "Compatibility" chapter has been added to the main README and individual gem READMEs. The versioning scheme follows the scheme for the Elasticsearch Ruby client, ie. the version number matches the supported major version of Elasticsearch. See: * elastic/elasticsearch-ruby@3bdb385
1 parent c871227 commit 3cc92cd

File tree

4 files changed

+58
-10
lines changed

4 files changed

+58
-10
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,27 @@ This repository contains various Ruby and Rails integrations for [Elasticsearch]
1616
Elasticsearch client and Ruby API is provided by the
1717
**[elasticsearch-ruby](https://github.com/elasticsearch/elasticsearch-ruby)** project.
1818

19-
## Installation
19+
## Compatibility
2020

2121
The libraries are compatible with Ruby 1.9.3 and higher.
2222

23-
Install the `elasticsearch-model` and/or `elasticsearch-rails` package from
24-
[Rubygems](https://rubygems.org/gems/elasticsearch):
23+
The version numbers follow the Elasticsearch major versions, and the `master` branch
24+
is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
25+
26+
| Rubygem | | Elasticsearch |
27+
|:-------------:|:-:| :-----------: |
28+
| 0.1 || 1.x |
29+
| 2.x || 2.x |
30+
| 5.x || 5.x |
31+
| master || master |
32+
33+
## Installation
34+
35+
Install each library from [Rubygems](https://rubygems.org/gems/elasticsearch):
2536

2637
```ruby
27-
gem install elasticsearch-model elasticsearch-rails
38+
gem install elasticsearch-model
39+
gem install elasticsearch-rails
2840
```
2941

3042
To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):

elasticsearch-model/README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
# Elasticsearch::Model
22

33
The `elasticsearch-model` library builds on top of the
4-
the [`elasticsearch`](https://github.com/elasticsearch/elasticsearch-ruby) library.
4+
the [`elasticsearch`](https://github.com/elastic/elasticsearch-ruby) library.
55

66
It aims to simplify integration of Ruby classes ("models"), commonly found
77
e.g. in [Ruby on Rails](http://rubyonrails.org) applications, with the
88
[Elasticsearch](http://www.elasticsearch.org) search and analytics engine.
99

10-
The library is compatible with Ruby 1.9.3 and higher.
10+
## Compatibility
11+
12+
This library is compatible with Ruby 1.9.3 and higher.
13+
14+
The library version numbers follow the Elasticsearch major versions, and the `master` branch
15+
is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
16+
17+
| Rubygem | | Elasticsearch |
18+
|:-------------:|:-:| :-----------: |
19+
| 0.1 || 1.x |
20+
| 2.x || 2.x |
21+
| 5.x || 5.x |
22+
| master || master |
1123

1224
## Installation
1325

elasticsearch-persistence/README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,19 @@
22

33
Persistence layer for Ruby domain objects in Elasticsearch, using the Repository and ActiveRecord patterns.
44

5-
The library is compatible with Ruby 1.9.3 (or higher) and Elasticsearch 1.0 (or higher).
5+
## Compatibility
6+
7+
This library is compatible with Ruby 1.9.3 and higher.
8+
9+
The library version numbers follow the Elasticsearch major versions, and the `master` branch
10+
is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
11+
12+
| Rubygem | | Elasticsearch |
13+
|:-------------:|:-:| :-----------: |
14+
| 0.1 || 1.x |
15+
| 2.x || 2.x |
16+
| 5.x || 5.x |
17+
| master || master |
618

719
## Installation
820

elasticsearch-rails/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
# Elasticsearch::Rails
22

3-
The `elasticsearch-rails` library is a companion for
4-
the [`elasticsearch-model`](https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-model)
3+
The `elasticsearch-rails` library is a companion for the
4+
the [`elasticsearch-model`](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model)
55
library, providing features suitable for Ruby on Rails applications.
66

7-
The library is compatible with Ruby 1.9.3 and higher.
7+
## Compatibility
8+
9+
This library is compatible with Ruby 1.9.3 and higher.
10+
11+
The library version numbers follow the Elasticsearch major versions, and the `master` branch
12+
is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
13+
14+
| Rubygem | | Elasticsearch |
15+
|:-------------:|:-:| :-----------: |
16+
| 0.1 || 1.x |
17+
| 2.x || 2.x |
18+
| 5.x || 5.x |
19+
| master || master |
820

921
## Installation
1022

0 commit comments

Comments
 (0)