Skip to content

Commit 2e1d173

Browse files
committed
Add versioning info to docs too
1 parent 7729c30 commit 2e1d173

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ The recommended way to set your requirements in your `setup.py` or
4040

4141
The development is happening on ``master`` and ``1.x`` branches, respectively.
4242

43-
4443
Installation
4544
------------
4645

docs/index.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@ For a more high level client library with more limited scope, have a look at
1414
Compatibility
1515
-------------
1616

17-
The library is compatible with both Elasticsearch 1.x and 0.90.x but you
18-
**have to use a matching version**.
17+
The library is compatible with all Elasticsearch versions since ``0.90.x`` but you
18+
**have to use a matching major version**:
19+
20+
For **Elasticsearch 2.0** and later, use the major version 1 (``1.x.y``) of the
21+
library.
1922

2023
For **Elasticsearch 1.0** and later, use the major version 1 (``1.x.y``) of the
2124
library.
@@ -26,13 +29,16 @@ library.
2629
The recommended way to set your requirements in your `setup.py` or
2730
`requirements.txt` is::
2831

29-
# Elasticsearch 1.0
32+
# Elasticsearch 2.x
33+
elasticsearch>=2.0.0,<3.0.0
34+
35+
# Elasticsearch 1.x
3036
elasticsearch>=1.0.0,<2.0.0
3137

32-
# Elasticsearch 0.90
38+
# Elasticsearch 0.90.x
3339
elasticsearch<1.0.0
3440

35-
The development is happening on ``master`` and ``0.4`` branches, respectively.
41+
The development is happening on ``master`` and ``1.x`` branches, respectively.
3642

3743
Example Usage
3844
-------------

0 commit comments

Comments
 (0)