From 88f16869a1d12f007f40070aade568254d1cb228 Mon Sep 17 00:00:00 2001 From: Randall Wilk Date: Mon, 20 Mar 2023 10:34:41 -0500 Subject: [PATCH] Update docs --- README.md | 10 ++++++++-- docs/installation.md | 2 +- docs/introduction.md | 4 ++++ docs/questions-and-issues.md | 2 +- docs/requirements.md | 4 +++- 5 files changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0537868..3c8982c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 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) @@ -6,7 +6,9 @@ [![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. @@ -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. diff --git a/docs/installation.md b/docs/installation.md index 8ab3387..1071d4f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 diff --git a/docs/introduction.md b/docs/introduction.md index bf8a1c2..babe42c 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -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. diff --git a/docs/questions-and-issues.md b/docs/questions-and-issues.md index 4f338a2..8013c62 100644 --- a/docs/questions-and-issues.md +++ b/docs/questions-and-issues.md @@ -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 [randall@randallwilk.dev](mailto:randall@randallwilk.dev) instead of using the issue tracker. diff --git a/docs/requirements.md b/docs/requirements.md index 3484374..6f327fe 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -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 | |