Updated docs for v7.0.0.

ash-jc-allen · Mar 23, 2023 · ae616de · ae616de
1 parent 20e4132
commit ae616de
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+**v7.0.0 (released 2023-03-23):**
+
+- Updated documentation to show the correct way to use the package. [#123](https://github.com/ash-jc-allen/laravel-exchange-rates/pull/123)
+- Updated the `RequestSender` interface (and all classes implementing it) to return a `ResponseContract` interface from the `makeRequest` method instead of `mixed`. [#126](https://github.com/ash-jc-allen/laravel-exchange-rates/pull/126)
+
 **v6.1.0 (released 2023-02-10):**
 
 - Added support for the "exchangerate.host" API. [#118](https://github.com/ash-jc-allen/laravel-exchange-rates/pull/118)

diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,17 @@
 # Upgrade Guide
 
+## Upgrading from 6.* to 7.0.0
+
+### Method Signature Change
+
+As of v7.0.0, the `makeRequest` method in the `AshAllenDesign\LaravelExchangeRates\Interfaces\RequestSender` interface has been updated to return an `AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract` interface instead of `mixed`.
+
+If you are implementing this interface in your own code, you'll need to update the method signature to the new format. The new `makeRequest` method signature is as follows:
+
+```php
+public function makeRequest(string $path, array $queryParams = []): ResponseContract;
+````
+
 ## Upgrading from 5.* to 6.0.0
 
 ### Updated the `ExchangeRate` Class to Use Drivers