Updated readme with initial upgrade instructions

mikebronner · mikebronner · commit af5f1930742f · 2017-03-20T14:28:43.000-07:00
Fixes #65
diff --git a/README.md b/README.md
@@ -29,6 +29,35 @@ This package allows you to use [**Geocoder**](http://geocoder-php.org/Geocoder/)
   // ];
   ```
 
+## Upgrading
+If you are upgrading from a pre-1.x version of this package, please keep the
+ following things in mind:
+
+1. Update your composer.json file as follows:
+  ```json
+  "toin0u/geocoder-laravel": "^1.0",
+  ```
+
+2. Remove your `config/geocoder.php` configuration file. (If you need to
+ customize it, follow the configuration instructions below.)
+3. Update the service provider entry in your `config/app.php` to read:
+  ```php
+  Geocoder\Laravel\Providers\GeocoderService::class,
+  ```
+  Also make sure you remove any Geocoder alias in the aliases section of this
+  file. (This package auto-registers the aliases.)
+3. If you are using the facade in your code, update the `use` statements to the
+ following:
+  ```php
+  use use Geocoder\Laravel\Facades\Geocoder;
+  ```
+
+ Alternatively you can replace the facades `Geocoder::` (and remove the corresponding `use`
+ statements) with `app('geocoder')->`.
+4. Update your query statements to use `->get()` (to retrieve a collection of
+ GeoCoder objects) or `->all()` (to retrieve an array of arrays), then iterate
+ to process each result.
+
 ## Configuration
 Pay special attention to the language and region values if you are using them.
  For example, the GoogleMaps provider uses TLDs for region values, and the
