Skip to content

Commit bcb7423

Browse files
committed
update docs
1 parent 71074ce commit bcb7423

File tree

3 files changed

+30
-11
lines changed

3 files changed

+30
-11
lines changed

Diff for: docs/010_Installation.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Requirements
44

5-
Minimum required PHP version is 8.1. *phpgeo* is tested up to PHP 8.3.
5+
Minimum required PHP version is 8.2. *phpgeo* is tested up to PHP 8.4.
66

77
New features will only go into the main branch and won't be backported.
88

@@ -12,10 +12,11 @@ Please refer to the following table for the compatibility matrix:
1212
### Compatibility Matrix
1313

1414
| PHP Version | phpgeo Version | Support Status | Composer Install |
15-
| :---------: | :------------: | :----------------: | --------------------------------------- |
16-
| 8.3 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
17-
| 8.2 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
18-
| 8.1 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
15+
|:-----------:|:--------------:| :----------------: | --------------------------------------- |
16+
| 8.4 | 6.x | ✅ active | `composer require mjaschen/phpgeo` |
17+
| 8.3 | 6.x | ✅ active | `composer require mjaschen/phpgeo` |
18+
| 8.2 | 6.x | ✅ active | `composer require mjaschen/phpgeo` |
19+
| 8.1 | 5.x | ⚠️ security only | `composer require mjaschen/phpgeo` |
1920
| 8.0 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
2021
| 7.4 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
2122
| 7.3 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |

Diff for: docs/015_Upgrading.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
# Upgrading phpgeo
22

3-
## Update from phpgeo 4.x to phpgeo 5.x
3+
### Upgrade from phpgeo 5.x to phpgeo 6.x
4+
5+
### Requirements
6+
7+
- *phpgeo* 6.x requires at least PHP 8.2.
8+
9+
### Update phpgeo
10+
11+
- run `composer require mjaschen/phpgeo:^6.0` or
12+
- update the version constraint in your `composer.json` to `^6.0` and run `composer update`
13+
14+
### Update Your Code
15+
16+
*phpgeo* has some breaking changes in the 6.x release line. Please refer to the following list to see what has changed
17+
and what you need to do to upgrade your code.
18+
19+
- Ensure your class has a `getBounds()` method if you implement `GeometryInterface` in your own classes.
20+
21+
## Upgrade from phpgeo 4.x to phpgeo 5.x
422

523
### Requirements
624

@@ -17,7 +35,7 @@
1735

1836
There are some new deprecations introduced in 5.0, please see the [change log](https://github.com/mjaschen/phpgeo/blob/main/CHANGELOG.md) for a detailed list and update your code accordingly to be prepared for 6.0.
1937

20-
## Update from phpgeo 3.x to phpgeo 4.x
38+
## Upgrade from phpgeo 3.x to phpgeo 4.x
2139

2240
### Requirements
2341

@@ -35,7 +53,7 @@ There are some new deprecations introduced in 5.0, please see the [change log](h
3553

3654
No breaking changes were introduced with *phpgeo* 3.0.
3755

38-
## Update from phpgeo 2.x to phpgeo 3.x
56+
## Upgrade from phpgeo 2.x to phpgeo 3.x
3957

4058
### Requirements
4159

Diff for: docs/020_Development.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ command to ensure the sources don't contain any syntax error:
3232
composer ci:lint
3333
```
3434

35-
A static code analysis with [Psalm](https://psalm.dev/) is configured as well:
35+
A static code analysis with [PHPStan](https://phpstan.org/) is configured as well:
3636

3737
``` shell
38-
composer ci:psalm
38+
composer ci:phpstan
3939
```
4040

4141
It's possible to run all tests at once:
@@ -47,7 +47,7 @@ composer ci
4747
… or run all CI tasks with different PHP versions one after another:
4848

4949
```shell
50-
for PHP_VERSION in 8.1 8.2 8.3 ; do \
50+
for PHP_VERSION in 8.2 8.3 8.4 ; do \
5151
docker run -it --rm -v "$PWD":/phpgeo -w /phpgeo \
5252
ghcr.io/mjaschen/php:${PHP_VERSION}-cli-mj composer ci || break ; \
5353
done

0 commit comments

Comments
 (0)