fixes #672 gettings started documentation

Author: Markus Kalkbrenner

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to the solarium library will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [5.0.1]
+### Fixed
+- Getting started documentation
+
+
 ## [5.0.0]
 ### Added
 - Component\Result\Facet\Bucket::getFacetSet()

README.md

@@ -7,25 +7,45 @@ Solarium is a PHP Solr client library that accurately model Solr concepts. Where
 the communication with Solr, Solarium also relieves you of handling all the complex Solr query parameters using a
 well documented API.
 
-Please see the docs for a more detailed description.
+Please see the [docs](http://solarium.readthedocs.io/en/stable/) for a more detailed description.
 
 ## Requirements
 
-Solarium only supports PHP 7.1 and up.
+Solarium 5.x only supports PHP 7.1 and up.
 
 It's highly recommended to have Curl enabled in your PHP environment. However if you don't have Curl available you can
 switch from using Curl (the default) to another client adapter. The other adapters don't support all the features of the
 Curl adapter.
 
 ## Getting started
 
-The preferred way to install Solarium is by using Composer. Solarium is available on Packagist.
+The preferred way to install Solarium is by using Composer. Solarium is available on
+[Packagist](https://packagist.org/packages/solarium/solarium).
 
 Example:
 ```
 composer require solarium/solarium
 ```
 
+### Pitfall when upgrading from earlier versions to 5.x
+
+In the past, the V1 API endpoint **_solr_** was not added automatically, so most users set it as path on the endpoint.
+This bug was discovered with the addition of V2 API support. In almost every setup, the path has to be set to `/`
+instead of `/solr` with this release!
+
+For the same reason it is a must to explicit configure the _core_ or _collection_.
+
+So an old setting like
+```
+'path' => '/solr/xxxx/'
+```
+has to be changed to something like
+```
+'path' => '/',
+'collection' => 'xxxx',
+```
+
+
 ## Run the examples
 
 This needs a git checkout using composer.

docs/getting-started.md

@@ -9,9 +9,9 @@ Installation
 
 ### Requirements
 
-For installing Solarium a minimal PHP version 5.3 is required. While previous Solarium versions with any PHP5 version, Solarium 3 uses interfaces so 5.3+ is a hard requirement.
+For installing Solarium a minimal PHP version 7.1 is required.
 
-There is no Solr version requirement. Solr versions 1.4 and upwards have been tested with Solarium. Ofcourse, if you want to use version specific features like spatial search you need the right Solr version. For spatial search you will need at least 3.1.
+There is no Solr version requirement. But it's highly recommended that you use at least 6.6.6.
 
 ### Getting Solarium
 
@@ -28,7 +28,7 @@ See [<https://packagist.org>](https://packagist.org) for other packages.
 ```json
 {
     "require": {
-        "solarium/solarium": "3.6.0"
+        "solarium/solarium": "~5.0.0"
     }
 }
 ```
@@ -75,6 +75,25 @@ htmlFooter();
 
 ```
 
+### Pitfall when upgrading from earlier versions to 5.x
+
+In the past, the V1 API endpoint **_solr_** was not added automatically, so most users set it as path on the endpoint.
+This bug was discovered with the addition of V2 API support. In almost every setup, the path has to be set to `/`
+instead of `/solr` with this release!
+
+For the same reason it is a must to explicit configure the _core_ or _collection_.
+
+So an old setting like
+```
+'path' => '/solr/xxxx/'
+```
+has to be changed to something like
+```
+'path' => '/',
+'collection' => 'xxxx',
+```
+
+
 ### Available integrations
 
 Some users of Solarium have been nice enough to create easy ways of integrating Solarium:
@@ -105,11 +124,13 @@ $config = array(
         'localhost' => array(
             'host' => '127.0.0.1',
             'port' => 8983,
-            'path' => '/solr/',
+            'path' => '/',
+            'core' => 'techproducts',
+            // For Solr Cloud you need to provide a collection instead of core:
+            // 'collection' => 'techproducts',
         )
     )
 );
-
 ```
 
 ### Selecting documents