Skip to content

Commit 7db1256

Browse files
author
Adil
committed
Minor README updates
1 parent 6fc4758 commit 7db1256

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ PHP implementation of the [PagerDuty Events API V2](https://v2.developer.pagerdu
55

66
UPGRADE NOTICE
77
---
8-
The [Events API V2](https://v2.developer.pagerduty.com/docs/events-api-v2) is **not backwards compatible** with the [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`
8+
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`
99

1010
[![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)
1111

@@ -85,26 +85,23 @@ try {
8585
true // Generate the dedup_key from the driver. If false, the dedup_key will be generated on PD
8686
);
8787

88-
// create a custom connection
88+
// create a custom proxy connection
8989
$connection = new PagerDutyHttpConnection();
9090

91-
// set additional connection configuration
92-
93-
// send event through proxy
91+
// .. and set the proxy
9492
$connection->setProxy('https://user:password@your-proxy-ip-address:port');
9593

96-
// set verbosity for debugging
94+
// set custom CURL options. Here we set verbosity for debugging
9795
$connection->addCurlOption('CURLOPT_VERBOSE', 1);
9896

99-
// send event
97+
// send event through proxy
10098
$connection->send($event);
10199
}
102100
catch(PagerDutyException $exception) { //This doesn't happen unless you've broken their guidelines. The API tries to minimize user mistakes
103101
var_dump($exception->getErrors());
104102
}
105103
catch (\Exception $e) {
106-
107-
// failed
104+
// A configuration exception
108105
}
109106

110107
````

0 commit comments

Comments
 (0)