Skip to content

Commit a09f3fb

Browse files
authored
Merge pull request #131 from Nexmo/clean-up-readme
Clean up README
2 parents b6e08fb + c3aca36 commit a09f3fb

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $client = new Nexmo\Client(new Nexmo\Client\Credentials\Basic(API_KEY, API_SECRE
5151
Examples
5252
--------
5353

54-
### Sending A Message
54+
### Sending a Message
5555

5656
To use [Nexmo's SMS API][doc_sms] to send an SMS message, call the `$client->message()->send()` method.
5757

@@ -111,7 +111,7 @@ foreach($text as $index => $data){
111111

112112
The [send example][send_example] also has full working examples.
113113

114-
### Receiving A Message
114+
### Receiving a Message
115115

116116
Inbound messages are [sent to your application as a webhook][doc_inbound], and the client library provides a way to
117117
create an inbound message object from a webhook:
@@ -132,7 +132,7 @@ $inbound = \Nexmo\Message\InboundMessage::createFromGlobals();
132132
error_log($inbound['to']);
133133
```
134134

135-
### Fetching A Message
135+
### Fetching a Message
136136

137137
You can retrieve a message log from the API using the ID of the message:
138138

@@ -153,7 +153,7 @@ echo "The body of the message was: " . $message->getBody();
153153

154154
### Starting a Verification
155155

156-
Nexmo's [Verify API][doc_verify] makes it easy to prove that a user has provided their own phone number during signup,
156+
Nexmo's [Verify API][doc_verify] makes it easy to prove that a user has provided their own phone number during signup,
157157
or implement second factor authentication during signin.
158158

159159
You can start a verification process using a simple array:
@@ -186,7 +186,7 @@ $verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5
186186
$client->verify()->cancel($verification);
187187
```
188188

189-
### Checking A Verification
189+
### Checking a Verification
190190

191191
In the same way, checking a verification requires the code the user provided, and an existing verification object:
192192

@@ -215,7 +215,7 @@ try {
215215
}
216216
```
217217

218-
### Searching For A Verification
218+
### Searching For a Verification
219219

220220
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:
@@ -238,7 +238,7 @@ $client->verify()->search($verification);
238238
echo "Verification cost was: " . $verification['price'] . PHP_EOL;
239239
```
240240

241-
### Making A Call
241+
### Making a Call
242242

243243
All `$client->calls()` methods require the client to be constructed with a `Nexmo\Client\Credentials\Keypair`, or a
244244
`Nexmo\Client\Credentials\Container` that includes the `Keypair` credentials:
@@ -280,7 +280,7 @@ $call->setTo('14843331234')
280280
$client->calls()->create($call);
281281
```
282282

283-
### Fetching A Call
283+
### Fetching a Call
284284

285285
You can fetch a call using a `Nexmo\Call\Call` object, or the call's UUID as a string:
286286

@@ -316,7 +316,7 @@ foreach($client->calls($filter) as $call){
316316
}
317317
```
318318

319-
### Creating An Application
319+
### Creating an Application
320320

321321
Application are configuration containers. You can create one using a simple array structure:
322322

@@ -387,7 +387,7 @@ You can search for numbers available to purchase in a specific country:
387387
$numbers = $client->numbers()->searchAvailable('US');
388388
```
389389

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

392392
To purchase a number, you can pass in a value returned from number search:
393393

@@ -520,4 +520,5 @@ This library is released under the [MIT License][license]
520520
[send_example]: examples/send.php
521521
[spec]: https://github.com/Nexmo/client-library-specification
522522
[issues]: https://github.com/Nexmo/nexmo-php/issues
523-
[pulls]: https://github.com/Nexmo/nexmo-php/pulls
523+
[pulls]: https://github.com/Nexmo/nexmo-php/pulls
524+

0 commit comments

Comments
 (0)