Skip to content

Commit b9ec640

Browse files
authored
Revise README
Updated links and maintenance information in README.
1 parent 6f613b9 commit b9ec640

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
PHP PagerDuty Events API
22
=========
3-
PHP implementation of the [PagerDuty Events API V2](https://v2.developer.pagerduty.com/docs/events-api-v2)
3+
PHP implementation of the [PagerDuty Events API V2](https://developer.pagerduty.com/api-reference/f80f5db9acbe3-pager-duty-v2-events-api)
4+
5+
[![Latest Stable Version](https://poser.pugx.org/adilbaig/pagerduty/v/stable.svg)](https://packagist.org/packages/adilbaig/pagerduty) [![Total Downloads](https://poser.pugx.org/adilbaig/pagerduty/downloads.svg)](https://packagist.org/packages/adilbaig/pagerduty)
46

57
Request for Maintainer
68
---
@@ -10,24 +12,38 @@ Request for Maintainer
1012

1113
Your mission, should you choose to accept it, is to upgrade this plugin to PHP 8.4. Fork this repo, make the changes and send me a PR. Once committed, I will transfer ownership of the repo over.
1214

13-
UPGRADE NOTICE
15+
**Update (2025-12-10):** @cheesegrits will be taking over maintenance of this project.
16+
17+
Compatibility
1418
---
15-
The [PagerDuty Events API V2](https://v2.developer.pagerduty.com/docs/events-api-v2) is **not backwards compatible** with the [PagerDuty Events API V1](https://v2.developer.pagerduty.com/docs/events-api). Hence, this API has changed. If you are upgrading from a [2.* release](https://github.com/adilbaig/pagerduty/releases), make sure you pay attention to the contructor of the `TriggerEvent`
1619

17-
[![Latest Stable Version](https://poser.pugx.org/adilbaig/pagerduty/v/stable.svg)](https://packagist.org/packages/adilbaig/pagerduty) [![Total Downloads](https://poser.pugx.org/adilbaig/pagerduty/downloads.svg)](https://packagist.org/packages/adilbaig/pagerduty)
20+
1. **v4.***: Requires `"php": ">=8.0"` . PagerDuty Events API V2.
21+
2. **v3.***: Requires `"php": ">=5.4.0"`. PagerDuty Events API V2. _If you are upgrading from a [2.* release](https://github.com/adilbaig/pagerduty/releases), make sure you pay attention to the contructor of the `TriggerEvent`_
22+
3. **v2.***: Requires `"php": ">=5.4.0"`. PagerDuty Events API V1.
1823

1924
Features
2025
---
2126

22-
- Compatible with [PagerDuty Events API V2](https://developer.pagerduty.com/docs/events-api-v2/trigger-events/).
27+
- Compatible with [PagerDuty Events API V2](https://developer.pagerduty.com/api-reference/f80f5db9acbe3-pager-duty-v2-events-api).
2328
- Trigger, Acknowledge and Resolve incidents.
2429
- Attach [Links](https://developer.pagerduty.com/docs/events-api-v2/trigger-events/#the-links-property) and [Images](https://developer.pagerduty.com/docs/events-api-v2/trigger-events/#the-images-property) to your incident reports.
2530
- Unit Tests
2631

2732

2833
Installation
2934
---
30-
Add this line to your project's `composer.json`
35+
For **PHP 8.\*** projects, add this line to your project's `composer.json`
36+
````
37+
{
38+
...
39+
"require": {
40+
"adilbaig/pagerduty": "4.*"
41+
}
42+
...
43+
}
44+
````
45+
46+
For PHP versions < 8, add this line to your project's `composer.json`
3147
````
3248
{
3349
...

0 commit comments

Comments
 (0)