Skip to content

Commit

Permalink
update README + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mjaschen
mjaschen committed Dec 7, 2023
1 parent 2729e4f commit 3c74efc
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 38 deletions.
40 changes: 22 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,27 @@ phpgeo provides abstractions to geographical coordinates (including support for

## Requirements

Minimum required PHP version is 7.3. *phpgeo* fully supports PHP 8 and is tested up to PHP 8.2.
Minimum required PHP version is 8.1. *phpgeo* is tested up to PHP 8.3.

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

| PHP Version | phpgeo Version | Support Status | Composer Install |
|:-------------:|:----------------:|:------------------:|---------------------------------------|
| 8.2 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.1 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.0 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 7.4 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 7.3 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 7.2 | 3.x | ⚠️ security only | `composer require mjaschen/phpgeo:^3.0`|
| 7.1 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0`|
| 7.0 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0`|
| 5.6 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0`|
| 5.5 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0`|
| 5.4 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0`|
It's possible to install older versions of *phpgeo* for older PHP versions.
Please refer to the following table for the compatibility matrix:

| PHP Version | phpgeo Version | Support Status | Composer Install |
| :---------: | :------------: | :----------------: | --------------------------------------- |
| 8.3 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.2 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.1 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.0 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
| 7.4 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
| 7.3 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
| 7.2 | 3.x | ❌ end of life | `composer require mjaschen/phpgeo:^3.0` |
| 7.1 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0` |
| 7.0 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0` |
| 5.6 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| 5.5 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| 5.4 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |

## Documentation

Expand All @@ -54,10 +58,10 @@ composer require mjaschen/phpgeo:^5.0

*phpgeo* has some breaking changes in the 5.x release line. Please refer to the following list to see what has changed and what you need to do to upgrade your code.

| Change | Description | Action |
| --- | --- |---------------------------------------------------------|
| `setPoint1()` and `setPoint2()` methods removed from `Line` | The `Line` class now is immutable. | Use the constructor to create a new instance of `Line`. |
| removed support for PHP 7.3, 7.4 and 8.0 | Older PHP versions are no longer supported. | Upgrade to at least PHP 8.1. |
| Change | Description | Action |
| ----------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------- |
| `setPoint1()` and `setPoint2()` methods removed from `Line` | The `Line` class now is immutable. | Use the constructor to create a new instance of `Line`. |
| removed support for PHP 7.3, 7.4 and 8.0 | Older PHP versions are no longer supported. | Upgrade to at least PHP 8.1. |

## License

Expand Down
38 changes: 18 additions & 20 deletions docs/010_Installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,29 @@

## Requirements

*phpgeo* requires at least PHP 8.1.
Minimum required PHP version is 8.1. *phpgeo* is tested up to PHP 8.3.

The 4.x releases require PHP >= 7.3 but don't get feature updates any longer. Bugfixes will be backported.
New features will only go into the main branch and won't be backported.

The 3.x releases require PHP >= 7.2 but don't get feature updates any longer. Bugfixes won't be backported.

The 2.x releases require PHP >= 7.0 but don't get feature updates any longer. Bugfixes won't be backported.

The 1.x release line has support for PHP >= 5.4. Bugfixes won't be backported.
It's possible to install previous versions of *phpgeo* for older PHP versions.
Please refer to the following table for the compatibility matrix:

### Compatibility Matrix

| PHP Version | phpgeo Version | Support Status | Composer Install |
|:-----------:|:--------------:|:----------------:|------------------------------------------|
| 8.2 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.1 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.0 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 7.4 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 7.3 | 4.x | ✅ active | `composer require mjaschen/phpgeo` |
| 7.2 | 3.x | ⚠️ security only | `composer require mjaschen/phpgeo:^3.0` |
| 7.1 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0` |
| 7.0 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0` |
| 5.6 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| 5.5 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| 5.4 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| PHP Version | phpgeo Version | Support Status | Composer Install |
| :---------: | :------------: | :----------------: | --------------------------------------- |
| 8.3 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.2 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.1 | 5.x | ✅ active | `composer require mjaschen/phpgeo` |
| 8.0 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
| 7.4 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
| 7.3 | 4.x | ⚠️ security only | `composer require mjaschen/phpgeo:^4.0` |
| 7.2 | 3.x | ❌ end of life | `composer require mjaschen/phpgeo:^3.0` |
| 7.1 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0` |
| 7.0 | 2.x | ❌ end of life | `composer require mjaschen/phpgeo:^2.0` |
| 5.6 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| 5.5 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |
| 5.4 | 1.x | ❌ end of life | `composer require mjaschen/phpgeo:^1.0` |

## Installation

Expand Down

0 comments on commit 3c74efc

Please sign in to comment.