Skip to content

Commit

Permalink
[DOCS] Remove incorrect Composer instructions from README (#565)
Browse files Browse the repository at this point in the history
Instructions on using the --no-dev flag were wrong as Composer will in this case never install the dev dependencies anyway. Dev dependencies are only ever resolved in the root package of an application for exactly the reasons that were described here. A consumer of the library will therefore never get the dev requirements of any library, with any flag.
  • Loading branch information
curry684 authored and polyfractal committed Apr 12, 2017
1 parent dc57bbc commit 9606f52
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The recommended method to install _Elasticsearch-PHP_ is through [Composer](http
3. Install your dependencies:

```bash
php composer.phar install --no-dev
php composer.phar install
```

4. Require Composer's autoloader
Expand All @@ -80,8 +80,6 @@ The recommended method to install _Elasticsearch-PHP_ is through [Composer](http
```
You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at [getcomposer.org](http://getcomposer.org).

You'll notice that the installation command specified `--no-dev`. This prevents Composer from installing the various testing and development dependencies. For average users, there is no need to install the test suite (which also includes the complete source code of Elasticsearch). If you wish to contribute to development, just omit the `--no-dev` flag to be able to run tests.

PHP Version Requirement
----
Version 5.0 of this library requires at least PHP version 5.6.6 to function. In addition, it requires the native JSON
Expand Down

0 comments on commit 9606f52

Please sign in to comment.