Skip to content

Commit b989985

Browse files
committed
Update documentation
1 parent 226225f commit b989985

File tree

5 files changed

+23
-5
lines changed

5 files changed

+23
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -753,24 +753,24 @@ The following resources contain more information: [Joomla! API Reference](http:
753753

754754
## Installation via Composer
755755

756-
Add `"joomla/github": "~2.0"` to the require block in your composer.json and then run `composer install`.
756+
Add `"joomla/github": "~4.0"` to the require block in your composer.json and then run `composer install`.
757757

758758
```json
759759
{
760760
"require": {
761-
"joomla/github": "~2.0"
761+
"joomla/github": "~4.0"
762762
}
763763
}
764764
```
765765

766766
Alternatively, you can simply run the following from the command line:
767767

768768
```sh
769-
composer require joomla/github "~2.0"
769+
composer require joomla/github "~4.0"
770770
```
771771

772772
If you want to include the test sources, use
773773

774774
```sh
775-
composer require --prefer-source joomla/github "~2.0"
775+
composer require --prefer-source joomla/github "~4.0"
776776
```

SECURITY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
These versions are currently being supported with security updates:
66

77
| Version | Supported |
8-
| ------- | ------------------ |
8+
|---------| ------------------ |
9+
| 4.x.x | :white_check_mark: |
10+
| 3.x.x | :white_check_mark: |
911
| 2.0.x | :white_check_mark: |
1012
| 1.7.x | :white_check_mark: |
1113
| < 1.7 | :x: |

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
* [Overview](overview.md)
2+
* [Updating from v2 to v3](v2-to-v3-update.md)
3+
* [Updating from v3 to v4](v3-to-v4-update.md)

docs/v2-to-v3-update.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Updating from v2 to v3
2+
3+
The following changes were made to the Github API package between v2 and v3.
4+
5+
### Minimum supported PHP version raised
6+
7+
All Framework packages now require PHP 8.1 or newer.

docs/v3-to-v4-update.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Updating from v3 to v4
2+
3+
The following changes were made to the Github API package between v3 and v4.
4+
5+
### Minimum supported PHP version raised
6+
7+
All Framework packages now require PHP 8.3 or newer.

0 commit comments

Comments
 (0)