Skip to content

Commit ffade71

Browse files
committed
docs: 📋 Update readme.
1 parent b942332 commit ffade71

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,17 @@
1010
> If you still use **Laravel 4**, please check out the `0.4.x` branch
1111
[here](https://github.com/geocoder-php/GeocoderLaravel/tree/0.4.x).
1212

13-
**Version 5.0.0 is a backwards-compatibility-breaking update. Please review
13+
**Version 13.0.0 is a backwards-compatibility-breaking update. Please review
1414
the _Upgrading_ section, especially the new default HTTP adapter, before
1515
installing.**
1616

17+
> **Versioning change:** starting with `13.0.0`, this package's major version
18+
> tracks the highest supported Laravel major version, instead of the upstream
19+
> Geocoder PHP version. So `13.x` supports Laravel 11/12/13, the next major
20+
> will be `14.x` when Laravel 14 ships, and so on. The previous tag was
21+
> `5.0.0`; the jump to `13.0.0` reflects the new versioning scheme, not 9
22+
> intermediate releases.
23+
1724
This package allows you to use [**Geocoder**](http://geocoder-php.org/Geocoder/)
1825
in [**Laravel**](http://laravel.com/).
1926

@@ -274,12 +281,15 @@ Anytime you upgrade this package, please remember to clear your cache, to preven
274281
php artisan cache:clear
275282
```
276283

277-
### 4.x to 5.x
284+
### 5.x to 13.x
278285
Update your `composer.json`:
279286
```json
280-
"toin0u/geocoder-laravel": "^5.0",
287+
"toin0u/geocoder-laravel": "^13.0",
281288
```
282289

290+
> Yes, the jump from `5.x` to `13.x` is intentional — see the versioning note
291+
> at the top of this README. There are no `5.x` through `12.x` releases.
292+
283293
**Breaking: default HTTP adapter changed.** The default `'adapter'` in
284294
`config/geocoder.php` is now `Geocoder\Laravel\Http\LaravelHttpClient`
285295
instead of `Http\Client\Curl\Client`. The new adapter is a PSR-18 client
@@ -299,13 +309,19 @@ If you have **published the geocoder config previously**, your config file
299309
`composer require php-http/curl-client`. The published config keeps working
300310
unchanged.
301311

302-
**Other notable changes in 5.x:**
312+
**Other notable changes in 13.x:**
303313
- Minimum PHP raised to 8.2; minimum Laravel raised to 11.x.
304314
- `php-http/curl-client` removed from required dependencies (install it
305315
yourself if you still need it).
306316
- `MaxMindBinary` provider support removed (the underlying PHP package was
307317
abandoned). Use `geocoder-php/geoip2-provider` for MaxMind data instead.
308318

319+
### 4.x to 5.x
320+
Update your `composer.json`:
321+
```json
322+
"toin0u/geocoder-laravel": "^5.0",
323+
```
324+
309325
### 1.x to 4.x
310326
Update your composer.json file:
311327
```json

0 commit comments

Comments
 (0)