diff --git a/README.md b/README.md index e69de29..7f83fb4 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,143 @@ +# 📦 Laravel Cropper (Takeone) + +A professional, multi-instance image cropping component for Laravel built on top of **Cropme**. This package allows you to easily add image upload, cropping, and deletion functionality with support for circular and rectangular viewports. + +--- + +## 🛠 1. Installation + +### Add Repository + +Add the following to your **main project's** `composer.json` file to allow Composer to find your package: + +JSON +``` +"repositories": [ + { + "type": "vcs", + "url": "https://git.innovator.bh/ghassan/laravel-image-cropper" + } +], +``` + +### Require Package + +Run the following command in your terminal: + +BASH +``` +composer require takeone/cropper +``` + +### Setup Storage + +The package saves images to the public disk. Link it to your project: + +BASH +``` +php artisan storage:link +``` + +--- + +## 🚀 2. Usage + +### Layout Setup + +Ensure your main layout file (e.g., `resources/views/layouts/app.blade.php`) includes **Bootstrap 5**, **jQuery**, and the `@stack('modals')` directive. + +```html + + + + + + + @yield('content') + + + + + @stack('modals') + + + +``` + +### Adding the Component + +Each instance of the cropper requires a **unique ID**. + +#### Profile Picture (Circle) + +html +``` + +``` + +#### Banner Image (Rectangle) + +html +``` +