From a7d66c891ae8adb308dd7f867aa98c6f8e129842 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Honza=20Kr=C3=A1l?= Date: Thu, 8 Oct 2015 04:00:13 +0200 Subject: [PATCH] Updated README for new versioning scheme --- README | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README b/README index 76656ff2..d59f6515 100644 --- a/README +++ b/README @@ -14,8 +14,11 @@ For a more high level client library with more limited scope, have a look at Compatibility ------------- -The library is compatible with both Elasticsearch 1.x and 0.90.x but you -**have to use a matching version**. +The library is compatible with all Elasticsearch versions since ``0.90.x`` but you +**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 library. @@ -26,13 +29,16 @@ library. The recommended way to set your requirements in your `setup.py` or `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 0.90 + # Elasticsearch 0.90.x 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. Installation