Skip to content

Commit d0b62f5

Browse files
authored
Update readme.md
1 parent 48691b3 commit d0b62f5

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

readme.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,34 @@
33

44
Latest OAuth 2.0 Rest API Wrapper for UPS web services.
55

6+
## Table Of Content
67

8+
1. [Requirements](#requirements)
9+
2. [Installation](#installation)
10+
3. [Address Validation](#addressvalidation)
11+
4. [Create Shipment | Shipping Label](#create-shipment)
12+
5. [Tracking API](#tracking)
13+
6. [Documentation](#api-docs)
14+
7. [License](#license-section)
715

16+
<a name="requirements"></a>
17+
## Requirements
818

19+
This library uses PHP 7.4+.
20+
21+
To integrate with the UPS API using OAuth 2.0 authentication, you'll need to [obtain a Client ID and Client Secret from UPS](https://developer.ups.com). These credentials must be included with each API request you make.
22+
23+
<a name="installation"></a>
924
## Installation
1025

1126
Install with composer
1227

1328
```bash
1429
composer require rahul-godiyal/php-ups-api-wrapper
1530
```
16-
17-
## Usage/Examples
1831

19-
UPS Address Validation
32+
<a name="addressvalidation"></a>
33+
## Address Validation
2034
```php
2135
<?php
2236

@@ -46,7 +60,8 @@ die();
4660

4761
```
4862

49-
Create Shipment | Shipping Label
63+
<a name="create-shipment"></a>
64+
## Create Shipment | Shipping Label
5065
```php
5166
<?php
5267

@@ -248,7 +263,9 @@ echo '<pre>'; print_r($shipRes); echo '</pre>';
248263
</html>
249264

250265
```
251-
Tracking API
266+
267+
<a name="tracking"></a>
268+
## Tracking API
252269
```php
253270
<?php
254271

@@ -268,3 +285,12 @@ echo '</pre>';
268285
die();
269286
```
270287

288+
<a name="api-docs"></a>
289+
## Documentation
290+
[UPS API docs](https://developer.ups.com/catalog)
291+
292+
293+
<a name="license-section"></a>
294+
## License
295+
296+
PHP UPS API is licensed under [The MIT License (MIT)](LICENSE).

0 commit comments

Comments
 (0)