Skip to content

Commit

Permalink
Update documentation regarding 1.0 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
polyfractal committed Feb 12, 2014
1 parent efc7ea8 commit 60fc559
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ Features
Version Matrix
--------------
Since there are breaking changes in Elasticsearch 1.0, you need to match your version of Elasticsearch to the appropriate version of this library.
The master branch will always track Elasticsearch master. Once 1.0.GA is released, a distinct 1.0 branch will be created to track Elasticsearch
1.* releases.
If you are using a version older than 1.0, you must install the `0.4` Elasticsearch-PHP branch. Otherwise, use the `1.0` branch.

The master branch will always track Elasticsearch master, but it is not recommended to use `dev-master` in your production code.

| Elasticsearch Version | Elasticsearch-PHP Branch |
| --------------------- | ------------------------ |
| >= 1.0 | dev-master |
| >= 1.0 | 1.0 |
| <= 0.90.* | 0.4 |

Documentation
Expand All @@ -40,7 +41,7 @@ The recommended method to install _Elasticsearch-PHP_ is through [Composer](http
```json
{
"require": {
"elasticsearch/elasticsearch": "~0.4"
"elasticsearch/elasticsearch": "~1.0"
}
}
```
Expand Down
18 changes: 8 additions & 10 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,14 @@ The rest of the dependencies will automatically be downloaded and installed by C
=== Version Matrix

Since there are breaking changes in Elasticsearch 1.0, you need to match your version of Elasticsearch to the appropriate version of this library.
The master branch will always track Elasticsearch master. Once 1.0.GA is released, a distinct 1.0 branch will be created to track Elasticsearch
1.* releases.
If you are using a version older than 1.0, you must install the `0.4` Elasticsearch-PHP branch. Otherwise, use the `1.0` branch.

.Version Matrix
[options="header"]
|===================================================
| Elasticsearch Version | Elasticsearch-PHP Branch
| >= 1.0 | dev-master
| <= 0.90.* | 0.4
|===================================================
The master branch will always track Elasticsearch master, but it is not recommended to use `dev-master` in your production code.

| Elasticsearch Version | Elasticsearch-PHP Branch |
| --------------------- | ------------------------ |
| >= 1.0 | 1.0 |
| <= 0.90.* | 0.4 |


=== Composer Installation
Expand All @@ -31,7 +29,7 @@ The master branch will always track Elasticsearch master. Once 1.0.GA is releas
--------------------------
{
"require": {
"elasticsearch/elasticsearch": "~0.4"
"elasticsearch/elasticsearch": "~1.0"
}
}
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section will give you a quick overview of the client and how the major func
----------------------------
{
"require": {
"elasticsearch/elasticsearch": "~0.4"
"elasticsearch/elasticsearch": "~1.0"
}
}
----------------------------
Expand Down

0 comments on commit 60fc559

Please sign in to comment.