Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rawilk committed Mar 20, 2023
1 parent bb9a280 commit 88f1686
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 5 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# laravel-ups
# UPS Wrapper for Laravel

[![Latest Version on Packagist](https://img.shields.io/packagist/v/rawilk/laravel-ups.svg?style=flat-square)](https://packagist.org/packages/rawilk/laravel-ups)
![Tests](https://github.com/rawilk/laravel-ups/workflows/Tests/badge.svg?style=flat-square)
[![Total Downloads](https://img.shields.io/packagist/dt/rawilk/laravel-ups.svg?style=flat-square)](https://packagist.org/packages/rawilk/laravel-ups)
[![PHP from Packagist](https://img.shields.io/packagist/php-v/rawilk/laravel-ups?style=flat-square)](https://packagist.org/packages/rawilk/laravel-ups)
[![License](https://img.shields.io/github/license/rawilk/laravel-ups?style=flat-square)](https://github.com/rawilk/laravel-ups/blob/main/LICENSE.md)

This package acts as an api wrapper for the [UPS Api](https://www.ups.com/upsdeveloperkit?loc=en_US). Currently this package allows you to validate addresses,
![social image](https://banners.beyondco.de/UPS%20API%20Wrapper.png?theme=light&packageManager=composer+require&packageName=rawilk%2Flaravel-ups&pattern=architect&style=style_1&description=UPS+api+wrapper+for+Laravel.&md=1&showWatermark=0&fontSize=100px&images=truck)

This package acts as an api wrapper for the [UPS Api](https://www.ups.com/upsdeveloperkit?loc=en_US). Currently, this package allows you to validate addresses,
create shipments, void shipments, recover labels, and track shipments. Before using this package, you should have at least a basic understanding
of the UPS Api.

Expand Down Expand Up @@ -53,6 +55,10 @@ Please review [my security policy](.github/SECURITY.md) on how to report securit
- [Randall Wilk](https://github.com/rawilk)
- [All Contributors](../../contributors)

## Disclaimer

This package is not affiliated with, maintained, authorized, endorsed or sponsored by Laravel or any of its affiliates. It is also not affiliated with, maintained, authorized, endorsed or sponsored by UPS.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You may publish the config file like this:
php artisan vendor:publish --tag="ups-config"
```

See the default configuration values [here](https://github.com/rawilk/laravel-ups/blob/main/config/ups.php).
See the default configuration values [here](https://github.com/rawilk/laravel-ups/blob/{branch}/config/ups.php).

### Configuring the package

Expand Down
4 changes: 4 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ sort: 1
This package acts as an api wrapper for the [UPS Api](https://www.ups.com/upsdeveloperkit?loc=en_US). Currently this package allows you to validate addresses,
create shipments, void shipments, recover labels, and track shipments. Before using this package, you should have at least a basic understanding
of the UPS Api.

## Disclaimer

This package is not affiliated with, maintained, authorized, endorsed or sponsored by Laravel or any of its affiliates. It is also not affiliated with, maintained, authorized, endorsed or sponsored by UPS.
2 changes: 1 addition & 1 deletion docs/questions-and-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sort: 5
---

Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the package?
Feel free to [create an issue on GitHub](https://github.com/rawilk/laravel-ups/issues) and I'll try to address it as soon as possible.
Feel free to [create an issue on GitHub](https://github.com/rawilk/laravel-ups/issues), and I'll try to address it as soon as possible.

> {note} If you've found a bug regarding security please email [[email protected]](mailto:[email protected]) instead of using the issue tracker.
4 changes: 3 additions & 1 deletion docs/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ sort: 2
## Version Matrix

| Laravel | Minimum Version | Maximum Version |
| ------- | --------------- | --------------- |
| ------- |-----------------| --------------- |
| 7.28 | 1.0.0 | 1.0.0 |
| 8.0 | 1.0.0 | |
| 9.0 | 2.1.3 | |
| 10.0 | 2.1.6 | |

0 comments on commit 88f1686

Please sign in to comment.