Initial commit

README.md

@@ -0,0 +1,59 @@
+<p align="center">
+<img width="150" height="150" src="assets/logo.png" alt="Laravel Package Skeleton Logo"/>
+<br><b>Laravel Package Skeleton</b>
+</p>
+<p align="center">
+<a href="https://github.com/algoyounes/laravel-package-skeleton/actions"><img src="https://github.com/algoyounes/laravel-package-skeleton/actions/workflows/unit-tests.yml/badge.svg" alt="Build Status"></a>
+<a href="https://packagist.org/packages/algoyounes/laravel-package-skeleton"><img src="https://img.shields.io/packagist/dt/algoyounes/laravel-package-skeleton" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/algoyounes/laravel-package-skeleton"><img src="https://img.shields.io/packagist/v/algoyounes/laravel-package-skeleton" alt="Latest Stable Version"></a>
+<a href="https://packagist.org/packages/algoyounes/laravel-package-skeleton"><img src="https://img.shields.io/packagist/l/algoyounes/laravel-package-skeleton" alt="License"></a>
+</p>
+
+Creating Laravel packages made it easy! You can start building your own modular, organized package effortlessly.
+
+> [!NOTE]
+> This package requires PHP 8.2+ and Laravel 11+ 
+
+## Installation
+
+You can install the package globally via composer:
+
+```
+composer global require algoyounes/laravel-package-skeleton
+```
+
+## Usage
+
+Once installed, you can use the following commands to streamline your package development process:
+
+**⚡️ Create your package using composer :**
+```
+composer create-project algoyounes/laravel-package-skeleton --prefer-source YourPackageName
+```
+
+**🚀 Run the entire test suite :**
+```
+composer test
+```
+
+Running `composer test` will execute the following tasks :
+- 🔄 Refactoring Tests: `composer rector`
+- 🧹 Linting Tests: `composer test:lint`
+- 🔍 Static Analysis Tests: `composer test:types`
+- 🛠️ Unit Tests: `composer test:unit`
+
+**🔧 Install Git Hooks:**
+```
+composer hook:install
+```
+Running `composer hook` will execute the following tasks :
+- 🔄 Pre-commit Hook: `composer hook:pre-commit`
+- 🧹 Pre-push Hook: `composer hook:pre-push`
+
+**🛠️ Fix code issues:**
+```
+composer fix
+```
+Running `composer fix` will execute the following tasks:
+- ✨ Laravel linting Fixes: `composer fix:lint`
+- 🔄 Refactoring Fixes: `composer fix:refactor`