Added upgrade guide

Author: Andrey Helldar

.upgrading/5.x_6.x.md

@@ -0,0 +1,52 @@
+# Upgrade Guide
+
+## Upgrading To 6.x From 5.x
+
+### PHP 7.3 Required
+
+The new minimum PHP version is now 7.3.
+
+### Updating Dependencies
+
+Update your `andrey-helldar/api-response` dependency to `^6.0` in your `composer.json` file.
+
+
+### `api_response` function
+
+Changed the order of `api_response` function attributes from:
+```php
+function api_response(                      
+    $data = null,
+    int $status_code = 200,
+    array $headers = [],
+    array $with = [],
+    bool $use_data = true
+)
+```
+
+to:
+```php
+function api_response(
+    $data = null,
+    int $status_code = 200,
+    array $with = [],
+    array $headers = [],
+    bool $use_data = true
+)
+```
+
+### The `status` method
+
+The `status` method from `Helldar\ApiResponse\Services\Response` has been removed.
+
+
+### The `data` method
+
+`data` method from `Helldar\ApiResponse\Services\Response` added status code attribute:
+```php
+function data(
+    $data = null,
+    int $status_code = 200,
+    bool $use_data = true
+)
+```

README.md

@@ -19,6 +19,7 @@ Package for standardizing the responses from the API of your **Symfony based** a
 
 ## Content
 * [Installation](#installation)
+    * [Compatibility table](#compatibility-table)
 * [Using](#using)
     * [Use with `data` key](#use-with-data-key)
         * [as NULL with code](#as-null-with-code)
@@ -51,16 +52,7 @@ $ composer require andrey-helldar/api-response
 
 This command will automatically install the latest version of the package for your environment.
 
-Or you can manually set the required version, following the table:
-
-| Package version | PHP version | Symfony version | Command |
-|:---:|:---:|:---:|:---|
-|  ^4.0 | 5.6.9+ | ^3.0, ^4.0 | `composer require andrey-helldar/api-response:^4.0` |
-|  ^4.4.1 | 5.6.9+ | ^3.0, ^4.0, ^5.0 | `composer require andrey-helldar/api-response:^4.4` |
-|  ^5.0 | 7.1.3+ | ^4.0, ^5.0 | `composer require andrey-helldar/api-response:^5.0` |
-|  ^6.0 | 7.3+ | ^4.0, ^5.0 | `composer require andrey-helldar/api-response` |
-
-Instead, you may of course manually update your require block and run `composer update` if you so choose:
+Instead, you may of course manually update your `require` block and run `composer update` if you so choose:
 
 ```json
 {
@@ -72,6 +64,17 @@ Instead, you may of course manually update your require block and run `composer
 
 Alright! Use `api_response()` helper.
 
+
+### Compatibility table
+
+| Package version | PHP min version | Symfony version | Support | Links |
+|:---:|:---:|:---:|:---|:---|
+|  ^4.0 | 5.6.9 | ^3.0, ^4.0 | ![Not Supported][badge_not_supported] | --- |
+|  ^4.4.1 | 5.6.9 | ^3.0, ^4.0, ^5.0 | ![Not Supported][badge_not_supported] | --- |
+|  ^5.0 | 7.1.3 | ^4.0, ^5.0 | ![Not Supported][badge_not_supported] | --- |
+|  ^6.0 | 7.3 | ^4.0, ^5.0 | ![Supported][badge_supported] | [Upgrade guide](.upgrading/5.x_6.x.md) |
+
+
 [[ to top ]](#api-response)
 
 
@@ -648,3 +651,7 @@ class Handler extends ExceptionHandler
 `API Response` was written by Andrey Helldar, and is licensed under the [MIT License](LICENSE).
 
 [[ to top ]](#api-response)
+
+
+[badge_supported]:      https://img.shields.io/badge/supported-green?style=flat-square
+[badge_not_supported]:  https://img.shields.io/badge/not--supported-lightgrey?style=flat-square