diff --git a/EXAMPLE.md b/EXAMPLE.md new file mode 100644 index 0000000..3281e7d --- /dev/null +++ b/EXAMPLE.md @@ -0,0 +1,130 @@ +# 🚀 Laravel Image Cropper - Quick Start Guide + +Follow these steps to get the **Laravel Cropper (Takeone)** package installed and working in your project in less than 5 minutes. + +--- + +## 🛠Step 1: Add the Repository + +Open your project's `composer.json` and add the custom repository. This is necessary because the package is currently hosted on a private Gitea server. + +```json +"repositories": [ + { + "type": "vcs", + "url": "https://git.innovator.bh/ghassan/laravel-image-cropper" + } +] +``` + +--- + +## 🛠Step 2: Install the Package + +Run the following command. **Note:** We use `@dev` to bypass the stability check since the package is in development. + +```bash +composer require takeone/cropper:@dev +``` + +--- + +## 🛠Step 3: Link Storage + +Run this command to make your uploaded images accessible from the web: + +```bash +php artisan storage:link +``` + +--- + +## 🛠Step 4: Prepare Your Layout + +Add **Bootstrap 5**, **jQuery**, and `@stack('modals')` to your `resources/views/layouts/app.blade.php`: + +```html + + +
+ + +Click the button below to upload and crop your photo.
+ +