actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Add versioning info to docs too

Browse Source
This commit is contained in:
Honza Král
2015-10-12 22:53:08 +02:00
parent 7729c3048f
commit 2e1d173f5c
2 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README
-1
View File
@@ -40,7 +40,6 @@ The recommended way to set your requirements in your `setup.py` or
The development is happening on ``master`` and ``1.x`` branches, respectively. The development is happening on ``master`` and ``1.x`` branches, respectively.
Installation Installation
------------ ------------
docs/index.rst
+11 -5
View File
@@ -14,8 +14,11 @@ For a more high level client library with more limited scope, have a look at
Compatibility Compatibility
------------- -------------
The library is compatible with both Elasticsearch 1.x and 0.90.x but you The library is compatible with all Elasticsearch versions since ``0.90.x`` but you
**have to use a matching version**. **have to use a matching major version**:
For **Elasticsearch 2.0** and later, use the major version 1 (``1.x.y``) of the
library.
For **Elasticsearch 1.0** and later, use the major version 1 (``1.x.y``) of the For **Elasticsearch 1.0** and later, use the major version 1 (``1.x.y``) of the
library. library.
@@ -26,13 +29,16 @@ library.
The recommended way to set your requirements in your `setup.py` or The recommended way to set your requirements in your `setup.py` or
`requirements.txt` is:: `requirements.txt` is::
# Elasticsearch 1.0 # Elasticsearch 2.x
elasticsearch>=2.0.0,<3.0.0
# Elasticsearch 1.x
elasticsearch>=1.0.0,<2.0.0 elasticsearch>=1.0.0,<2.0.0
# Elasticsearch 0.90 # Elasticsearch 0.90.x
elasticsearch<1.0.0 elasticsearch<1.0.0
The development is happening on ``master`` and ``0.4`` branches, respectively. The development is happening on ``master`` and ``1.x`` branches, respectively.
Example Usage Example Usage
------------- -------------