Skip to content

Commit 65c3188

Browse files
committed
adding documentation for Address Validation
1 parent 96ff30c commit 65c3188

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $address = new Address([
6262

6363
$response = $address->validate();
6464
```
65-
The USPS api limits 5 address validations per request. If you need to validate more than one address at a time, pass a multi dim array to the `Address` constructor.
65+
The USPS api supports up to 5 address validations per request. If you need to validate more than one address at a time, pass a multi dim array to the `Address` constructor.
6666

6767
```php
6868
use ctwillie\Usps\Address;
@@ -86,6 +86,8 @@ $addresses = new Address([$address1, $address2])
8686
$response = $addresses->validate();
8787
```
8888

89+
The response will contain the [corrected address](https://www.usps.com/business/web-tools-apis/address-information-api.pdf), or an error if not enough information was given or the address does not exists.
90+
8991
## Contributing
9092

9193
Contributions are always welcomed and will receive full credit.

0 commit comments

Comments
 (0)