diff --git a/README.md b/README.md index 6c4dda9..8ba7079 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,11 @@ After installing for the first time publish the config file with A default config file called `imageresize.php` will be available in your Laravel `app/config` folder. See this file for more details. ## How does it work -Let's assume you have an image in /public/media/images/test.jpg and a template called 'thumbnail'. And have set the imageresize.route config to 'media/resized'. -Referring to /media/resized/thumbnail/images/test.jpg will trigger the imageresize route in laravel since the file doesn't exist. Imageresize then creates the resized image and saves it as /public/media/resized/thumbnail/images/test.jpg -So the next time you refer to /media/resized/thumbnail/images/test.jpg the file does exist and the image is served without triggering any php/laravel code for optimal performance. +Let's assume you have an image in `/public/media/images/test.jpg` and a template called `thumbnail`. And have set the imageresize.route config to `media/resized`. + +Referring to `http://domain.com/media/resized/thumbnail/images/test.jpg` will trigger the imageresize route in laravel since the file doesn't exist. Imageresize then creates the resized image and saves it as `/public/media/resized/thumbnail/images/test.jpg`. + +So the next time you refer to `http://domain.com/media/resized/thumbnail/images/test.jpg` the file does exist and the image is served without triggering any php/laravel code for optimal performance. ## Drawbacks There is however one disadvantage: if the original image is edited or removed the resized file will still remain the same since referring to it doesn't trigger the imageresize package. You will have to manually delete it or use the `php artisan imageresize:delete` command.