Update README.md with project overview, features, technology stack, i…

README.md

@@ -1,61 +1,62 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
-
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
-
-## About Laravel
-
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
-
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
-
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
-
-## Learning Laravel
-
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
-
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
-
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
-
-## Laravel Sponsors
-
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
-
-### Premium Partners
-
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
-- **[Redberry](https://redberry.international/laravel-development/)**
-- **[Active Logic](https://activelogic.com)**
-
-## Contributing
-
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
-
-## Code of Conduct
-
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
-
-## Security Vulnerabilities
-
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+#  ███████╗     ██╗  ██████╗ ██████╗ ██████╗ ██████╗ ██╗███████╗
+#  ██╔════╝     ██║ ██╔═══██╗██╔══██╗██╔══██╗██╔══██╗██║██╔════╝
+#  ███████╗     ██║ ██║   ██║██████╔╝██████╔╝██████╔╝██║█████╗  
+#  ╚════██║██   ██║ ██║   ██║██╔═══╝ ██╔═══╝ ██╔═══╝ ██║██╔══╝  
+#  ███████║╚█████╔╝ ╚██████╔╝██║     ██║     ██║     ██║███████╗
+#  ╚══════╝ ╚════╝   ╚═════╝ ╚═╝     ╚═╝     ╚═╝     ╚═╝╚══════╝
+#  █████╗ ██████╗ ██╗
+#  ██╔══██╗██╔══██╗██║
+#  ███████║██████╔╝██║
+#  ██╔══██║██╔═══╝ ██║
+#  ██║  ██║██║     ██║
+#  ╚═╝  ╚═╝╚═╝     ╚═╝
+
+[![Latest Version](https://img.shields.io/github/v/release/CODEIQBV/sjoppie-api?style=flat-square)](https://github.com/CODEIQBV/sjoppie-api/releases)
+[![License](https://img.shields.io/github/license/CODEIQBV/sjoppie-api?style=flat-square)](LICENSE.md)
+[![PHP Version](https://img.shields.io/badge/php-8.1%2B-blue?style=flat-square)](https://php.net)
+[![Laravel Version](https://img.shields.io/badge/laravel-10.x-orange?style=flat-square)](https://laravel.com)
+
+The Sjoppie API is a robust e-commerce backend system developed by CodeIQ B.V. It provides a comprehensive set of RESTful endpoints for managing products, orders, payments, and customer data.
+
+## Features
+
+- **Product Management**: Full CRUD operations for products, variants, prices, and stock
+- **Order Processing**: Complete order lifecycle management with payment integration
+- **Customer Management**: Customer profiles with address management
+- **Payment Integration**: Multiple payment gateway support with webhook handling
+- **Stock Control**: Advanced stock management with available, on-hand, and reserved quantities
+- **Authentication**: Secure API key and token-based authentication
+- **Rate Limiting**: Built-in rate limiting for API protection
+
+## Technology Stack
+
+- PHP 8.1+
+- Laravel 10.x
+- MySQL/PostgreSQL
+- RESTful API architecture
+- JWT Authentication
+- Payment Gateway Integration (Mollie, etc.)
+
+## Documentation
+
+Detailed API documentation is available in the [docs](docs) directory:
+
+- [API Overview](docs/api.md)
+- [Authentication](docs/users.md)
+- [Products](docs/products.md)
+- [Orders](docs/orders.md)
+- [Payments](docs/payment.md)
+- [Stock Management](docs/stock.md)
+- [Workflow](docs/workflow.md)
+
+## Security
+
+- API key authentication required for all endpoints
+- Rate limiting enabled by default
+- CSRF protection for web routes
+- Secure password hashing
+- Input validation and sanitization
 
 ## License
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+This project is proprietary software developed by CodeIQ B.V. All rights reserved.