Skip to content

Commit 3bdb385

Browse files
committed
Added a compatibility matrix to the libraries' READMEs
Closes #322 Closes #323
1 parent 235407c commit 3bdb385

File tree

4 files changed

+32
-23
lines changed

4 files changed

+32
-23
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,18 @@ see the <https://github.com/elasticsearch/elasticsearch-rails> project.
1111

1212
## Compatibility
1313

14-
The libraries are compatible with Ruby 1.8.7 and higher.
15-
16-
The library is compatible with Elasticsearch 0.90, 1.x and 2.x -- you have to install and use a matching version, though.
17-
18-
The 1.x versions and the master branch are compatible with Elasticsearch 1.x and 2.x APIs.
19-
20-
To use the **Elasticsearch 0.90** API, install the **0.4.x** gem version or use the corresponding
21-
[`0.4`](https://github.com/elasticsearch/elasticsearch-ruby/tree/0.4) branch.
14+
The Elasticsearch client is compatible with Ruby 1.8.7 and higher.
15+
Other libraries in this repository might require a more recent Ruby version.
16+
17+
The client's API is compatible with Elasticsearch's API versions from 0.90 till current,
18+
just use a release matching major version of Elasticsearch.
19+
20+
| Ruby | | Elasticsearch |
21+
|:-------------:|:-:| :-----------: |
22+
| 0.90 || 0.90 |
23+
| 1.x || 1.x |
24+
| 2.x || 2.x |
25+
| master || master |
2226

2327
## Installation
2428

elasticsearch-api/README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,19 @@ The `elasticsearch-api` library provides a Ruby implementation of
99
the [Elasticsearch](http://elasticsearch.org) REST API.
1010

1111
It does not provide an Elasticsearch client; see the
12-
[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport)
13-
library.
12+
[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
1413

15-
The library is compatible with Ruby 1.8.7 or higher.
14+
The library is compatible with Ruby 1.8.7 and higher.
1615

17-
The library is compatible with Elasticsearch 0.90, 1.x and 2.x -- you have to install and use a matching version, though.
16+
It is compatible with Elasticsearch's API versions from 0.90 till current,
17+
just use a release matching major version of Elasticsearch.
1818

19-
The 1.x versions and the master branch are compatible with Elasticsearch 1.x and 2.x APIs.
20-
21-
To use the **Elasticsearch 0.90** API, install the **0.4.x** gem version or use the corresponding
22-
[`0.4`](https://github.com/elasticsearch/elasticsearch-ruby/tree/0.4) branch.
19+
| Ruby | | Elasticsearch |
20+
|:-------------:|:-:| :-----------: |
21+
| 0.90 || 0.90 |
22+
| 1.x || 1.x |
23+
| 2.x || 2.x |
24+
| master || master |
2325

2426
## Installation
2527

elasticsearch-transport/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ data serialization and transport.
1616
It does not handle calling the Elasticsearch API;
1717
see the [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api) library.
1818

19-
The library is compatible with Ruby 1.8.7 or higher and with Elasticsearch 0.90 and 1.0.
19+
The library is compatible with Ruby 1.8.7 or higher and with all versions of Elasticsearch since 0.90.
2020

2121
Features overview:
2222

elasticsearch/README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,17 @@ see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
1919

2020
## Compatibility
2121

22-
The library is compatible with Ruby 1.8.7 and higher.
22+
The Elasticsearch client for Ruby is compatible with Ruby 1.8.7 and higher.
2323

24-
The library is compatible with Elasticsearch 0.90 and 1.0 -- you have to install and use a matching version, though.
24+
The client's API is compatible with Elasticsearch's API versions from 0.90 till current,
25+
just use a release matching major version of Elasticsearch.
2526

26-
The 1.x versions and the master branch are compatible with **Elasticsearch 1.0** API.
27-
28-
To use the **Elasticsearch 0.90** API, install the **0.4.x** gem version or use the corresponding
29-
[`0.4`](https://github.com/elasticsearch/elasticsearch-ruby/tree/0.4) branch.
27+
| Ruby | | Elasticsearch |
28+
|:-------------:|:-:| :-----------: |
29+
| 0.90 || 0.90 |
30+
| 1.x || 1.x |
31+
| 2.x || 2.x |
32+
| master || master |
3033

3134
## Installation
3235

0 commit comments

Comments
 (0)