Skip to content

Commit 542fbe4

Browse files
sbinemheap
authored andcommitted
Improve grammatical consistency in README
- Re-worded the Searching, Purchasing, and Secrets sections to read more similarly to the earlier sections - Fixed `existing` typos - Standardized punctuation - Fixed broken `issues` link, added `pulls` link
1 parent 4c9d1b8 commit 542fbe4

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ $client->verify()->cancel($verification);
188188

189189
### Checking A Verification
190190

191-
In the same way, checking a verification requires the code the user provided, and an exiting verification object:
191+
In the same way, checking a verification requires the code the user provided, and an existing verification object:
192192

193193
```php
194194
$verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
@@ -217,7 +217,7 @@ try {
217217

218218
### Searching For A Verification
219219

220-
You can check the status of a verification, or access the results of past verifications using either an exsisting
220+
You can check the status of a verification, or access the results of past verifications using either an existing
221221
verification object, or a request ID. The verification object will then provide a rich interface:
222222

223223
```php
@@ -318,14 +318,14 @@ foreach($client->calls($filter) as $call){
318318

319319
### Creating An Application
320320

321-
Application are configuration containers, and you can create one using a simple array structure:
321+
Application are configuration containers. You can create one using a simple array structure:
322322

323323
```php
324324
$application = $client->applications()->create([
325325
'name' => 'My Application',
326326
'answer_url' => 'https://example.com/answer',
327327
'event_url' => 'https://example.com/event'
328-
])
328+
]);
329329
```
330330

331331
You can also pass the client an application object:
@@ -379,24 +379,24 @@ $application = $client->applications()->update([
379379
], '1a20a124-1775-412b-b623-e6985f4aace0');
380380
```
381381

382-
### Search available numbers
382+
### Search Available Numbers
383383

384-
You can search for numbers available to purchase in a specific country
384+
You can search for numbers available to purchase in a specific country:
385385

386386
```php
387387
$numbers = $client->numbers()->searchAvailable('US');
388388
```
389389

390-
### Purchase number
390+
### Purchase A Number
391391

392-
To purchase a number, you can pass in a value returned from number search
392+
To purchase a number, you can pass in a value returned from number search:
393393

394-
```
394+
```php
395395
$numbers = $client->numbers()->searchAvailable('US');
396396
$client->numbers()->purchase($numbers[0]);
397397
```
398398

399-
Or you can specify the number and country manually
399+
Or you can specify the number and country manually:
400400

401401
```php
402402
$client->numbers()->purchase('14155550100', 'US');
@@ -406,7 +406,7 @@ $client->numbers()->purchase('14155550100', 'US');
406406

407407
An API is provided to allow you to rotate your API secrets. You can create a new secret (up to a maximum of two secrets) and delete the existing one once all applications have been updated.
408408

409-
Get a list of the secrets:
409+
To get a list of the secrets:
410410

411411
```php
412412
$secretCollection = $client->account()->listSecrets(API_KEY);
@@ -416,13 +416,13 @@ foreach($secretCollection['secrets'] as $secret) {
416416
}
417417
```
418418

419-
Create a new secret (the created dates will help you know which is which):
419+
You can create a new secret (the created dates will help you know which is which):
420420

421421
```php
422422
$client->account()->createSecret(API_KEY, 'awes0meNewSekret!!;');
423423
```
424424

425-
Delete the old secret (any application still using these credentials will stop working):
425+
And delete the old secret (any application still using these credentials will stop working):
426426

427427
```php
428428
try {
@@ -442,9 +442,9 @@ Fatal error: Uncaught exception 'GuzzleHttp\Exception\RequestException' with mes
442442

443443
This is due to some PHP installations not shipping with a list of trusted CA certificates. This is a system configuration problem, and not specific to either cURL or Nexmo.
444444

445-
> *IMPORTANT*: In the next paragraph we provide a link to a CA certificate bundle. Nexmo do not guarantee the safety of this bundle, and you should review it yourself before installing any CA bundle on your machine
445+
> *IMPORTANT*: In the next paragraph we provide a link to a CA certificate bundle. Nexmo do not guarantee the safety of this bundle, and you should review it yourself before installing any CA bundle on your machine.
446446
447-
To resolve this issue, download a list of trusted CA certificates (e.g. the [curl](https://curl.haxx.se/ca/cacert.pem) bundle) and copy it on to your machine. once this is done, edit `php.ini` and set the `curl.cainfo` parameter:
447+
To resolve this issue, download a list of trusted CA certificates (e.g. the [curl](https://curl.haxx.se/ca/cacert.pem) bundle) and copy it on to your machine. Once this is done, edit `php.ini` and set the `curl.cainfo` parameter:
448448

449449
```
450450
# Linux/MacOS
@@ -504,7 +504,7 @@ The `legacy` branch can be used to require that earlier version. During the tran
504504
branches will have both new and legacy code. The [API coverage](#API-Coverage) section identifies what features are
505505
currently implemented and up to date.
506506

507-
To contribute to the library, docs, or examples, [create an issue][issues] or a pull request. Please only raise issues
507+
To contribute to the library, docs, or examples, [create an issue][issues] or [a pull request][pulls]. Please only raise issues
508508
about features marked as working in the [API coverage](#API-Coverage) as the rest of the code is being updated.
509509

510510
License
@@ -519,3 +519,5 @@ This library is released under the [MIT License][license]
519519
[license]: LICENSE.txt
520520
[send_example]: examples/send.php
521521
[spec]: https://github.com/Nexmo/client-library-specification
522+
[issues]: https://github.com/Nexmo/nexmo-php/issues
523+
[pulls]: https://github.com/Nexmo/nexmo-php/pulls

0 commit comments

Comments
 (0)