From 64eeb4c14b1437c46ab8318361542c91a6dbf51f Mon Sep 17 00:00:00 2001
From: Bastien MONTOIS <bastien.montois@gmail.com>
Date: Mon, 13 Nov 2023 09:58:16 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20add=20README.md=20and=20?=
 =?UTF-8?q?LICENSE=20files?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

📄 docs(README.md): provide comprehensive documentation for the Colissimo Pickup Point API Wrapper for Node.js, including features, installation, usage, API reference, contributing, license, and disclaimer

🔏 docs(LICENSE): add MIT License to the project to clarify permissions and limitations for users and contributors
---
 LICENSE   | 21 +++++++++++++++++
 README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..74efadb
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 bqst <bastien.montois@gmail.com> (<https://www.bqst.fr>)
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51d8574
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+# Colissimo Pickup Point API Wrapper for Node.js
+
+This package provides a convenient wrapper for the Colissimo PickupPoint Web Services, specifically for the findRDVPointRetraitAcheminement method. It is written in TypeScript, offering type safety and easy integration with TypeScript projects.
+
+## Features
+
+- Easy-to-use interface for the findRDVPointRetraitAcheminement method of Colissimo API.
+- Built with TypeScript for type safety.
+- Includes TypeScript types for request parameters and response objects.
+
+## Installation
+
+To install the package, run the following command:
+
+```bash
+npm install colissimo-pickup-point
+```
+
+or if you use Yarn:
+
+```bash
+yarn add colissimo-pickup-point
+```
+
+## Usage
+
+Here's a basic example of how to use the package:
+
+```typescript
+import ColissimoAPI from '<your-package-name>';
+
+const api = new ColissimoAPI();
+
+api.findRDVPointRetraitAcheminement({
+  accountNumber: 'YOUR_ACCOUNT_NUMBER',
+  password: 'YOUR_PASSWORD',
+  // ... other required parameters
+}).then(response => {
+  console.log(response);
+}).catch(error => {
+  console.error(error);
+});
+```
+
+## API Reference
+
+### `findRDVPointRetraitAcheminement(params: FindRDVPointRetraitAcheminementParams): Promise<FindRDVPointRetraitAcheminementResponse>`
+
+Fetches pickup points based on provided parameters.
+
+- `params`: An object containing all necessary parameters as per the Colissimo API documentation.
+
+Returns
+
+A Promise that resolves to the response object of the findRDVPointRetraitAcheminement method.
+
+## Contributing
+
+Contributions are welcome! Please see our [contributing guidelines](CONTRIBUTING.md) for more details.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Disclaimer
+
+This package is not affiliated with Colissimo or La Poste in any way. It is an independent wrapper for the Colissimo PickupPoint Web Services.