From 79009dfdbdb0bc802acf38f7c9db6a0fc2233a81 Mon Sep 17 00:00:00 2001 From: AlexisPPLIN Date: Tue, 10 Feb 2026 17:08:32 +0100 Subject: [PATCH 1/5] docs: update README with comprehensive documentation and installation guide --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 63 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 19d9358..c0eb8cf 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,69 @@ # Sendcloud -This library only supports Sendcloud API v3. -For v3, checkout https://github.com/Webador/sendcloud +![Packagist Version](https://img.shields.io/packagist/v/alexispplin/sendcloud-v3?link=https%3A%2F%2Fpackagist.org%2Fpackages%2Falexispplin%2Fsendcloud-v3) +![PHP Version](https://img.shields.io/badge/php-%3E%3D8.2-8892BF.svg) +![License](https://img.shields.io/github/license/AlexisPPLIN/sendcloud-v3) -## Installation +## 📦 About -TODO +Implementation of Sendcloud v3 API for PHP -## Supported Endpoints +> [!NOTE] +> For v2 users, use [Webador/sendcloud](https://github.com/Webador/sendcloud) -- Orders +## ⚙️ Requirements + +- PHP 8.2+ +- PSR7 & PSR17 implementation + +## 🛠️ Installation + +```bash +composer require alexispplin/sendcloud-v3 +``` + +> [!NOTE] +> This library uses [HTTPlug](https://docs.php-http.org/en/latest/httplug/users.html) + +For this lib to work, you will need to install a PSR7 & PSR17 implementation. +Check the full documentation here : https://docs.php-http.org/en/latest/httplug/users.html + +For example : +```bash +composer require symfony/http-client nyholm/psr7 +``` + +## 🌐 Supported Endpoints + +- [Orders](https://sendcloud.dev/api/v3/orders) + +## 💡 Quick start + +```php +getOrder(id: 1); +``` + +## 🤝 Contributing + +Contributions are welcome! Please follow these steps: +1. Fork the repository +2. Create a branch for your feature +3. Commit your changes +5. Create a Pull Request to the main branch + +## 📄 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. From 2640fc56839e037da019cad69902d8de7f02e698 Mon Sep 17 00:00:00 2001 From: Alexis POUPELIN Date: Wed, 11 Feb 2026 09:28:49 +0100 Subject: [PATCH 2/5] Add MIT License to the project --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..83e95c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Alexis POUPELIN + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 92c0c49a02d7e52f3c5ef7257f3c3c5ba1f56fa6 Mon Sep 17 00:00:00 2001 From: AlexisPPLIN Date: Wed, 11 Feb 2026 09:34:49 +0100 Subject: [PATCH 3/5] Updated readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0eb8cf..fc63711 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Sendcloud ![Packagist Version](https://img.shields.io/packagist/v/alexispplin/sendcloud-v3?link=https%3A%2F%2Fpackagist.org%2Fpackages%2Falexispplin%2Fsendcloud-v3) -![PHP Version](https://img.shields.io/badge/php-%3E%3D8.2-8892BF.svg) ![License](https://img.shields.io/github/license/AlexisPPLIN/sendcloud-v3) ## 📦 About @@ -10,6 +9,7 @@ Implementation of Sendcloud v3 API for PHP > [!NOTE] > For v2 users, use [Webador/sendcloud](https://github.com/Webador/sendcloud) +> (which this library is heavily inspired by) ## ⚙️ Requirements From 1c36b7b57b7a78c6adebd354f3a8ba93acca2550 Mon Sep 17 00:00:00 2001 From: AlexisPPLIN Date: Wed, 11 Feb 2026 09:35:39 +0100 Subject: [PATCH 4/5] Added api link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc63711..3df916d 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ ## 📦 About -Implementation of Sendcloud v3 API for PHP +Implementation of [Sendcloud v3 API](https://sendcloud.dev/api/v3) for PHP > [!NOTE] -> For v2 users, use [Webador/sendcloud](https://github.com/Webador/sendcloud) +> For v2 users, use [Webador/sendcloud](https://github.com/Webador/sendcloud) > (which this library is heavily inspired by) ## ⚙️ Requirements From 6ee508e05445a2741e20e0af5cf050382db96457 Mon Sep 17 00:00:00 2001 From: AlexisPPLIN Date: Wed, 11 Feb 2026 09:37:05 +0100 Subject: [PATCH 5/5] Updated readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3df916d..7bced93 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Sendcloud +# Sendcloud v3 ☁️ ![Packagist Version](https://img.shields.io/packagist/v/alexispplin/sendcloud-v3?link=https%3A%2F%2Fpackagist.org%2Fpackages%2Falexispplin%2Fsendcloud-v3) ![License](https://img.shields.io/github/license/AlexisPPLIN/sendcloud-v3)