Merge branch 'release/3.0.1'

Author: adrenth

CHANGELOG.md

@@ -0,0 +1,26 @@
+# 3.0.1
+
+- Add missing CHANGELOG file.
+
+# 3.0.0
+
+- Drop support for PHP 7.1 (minimum required PHP version 7.4)
+- Improved plugin documentation.
+- Add Sign Key implementation (please add `GLIDE_SIGN_KEY` to your `.env`)
+
+# 2.0.0
+
+- __!!! October Build 1.1.0 required__
+- Make laravel 6 compatible.
+
+# 1.1.0
+
+- Move thumbnail generation logic to a (re-usable) Helper.
+
+# 1.0.1
+
+- Catch exception when file cannot be found or image could not be created.
+
+# 1.0.0
+
+- First version of Vdlp.Glide

README.md

@@ -1,6 +1,8 @@
 # Vdlp.Glide
 
-Glide is a wonderfully easy on-demand image manipulation library written in PHP. Its straightforward API is exposed via HTTP, similar to cloud image processing services like Imgix and Cloudinary. Glide leverages powerful libraries like Intervention Image (for image handling and manipulation) and Flysystem (for file system abstraction).
+Glide is a wonderfully easy on-demand image manipulation library written in PHP. 
+Its straightforward API is exposed via HTTP, similar to cloud image processing services like Imgix and Cloudinary. 
+Glide leverages powerful libraries like Intervention Image (for image handling and manipulation) and Flysystem (for file system abstraction).
 
 ## Requirements
 
@@ -30,17 +32,21 @@ GLIDE_IMAGE_DRIVER = "gd"
 GLIDE_SIGN_KEY = "[YOUR SIGN KEY HERE]"
 ```
 
+> We recommend using a 128 character (or larger) signing key to prevent trivial key attacks. Consider using a package like [CryptoKey](https://github.com/AndrewCarterUK/CryptoKey) to generate a secure key.
+
+For more details about the security and why a sign key is used, check [glide.thephpleague.com](https://glide.thephpleague.com/2.0/config/security/).
+
 Add an url to your disk in the `config/filesystem.php` to display the images properly, for example:
 
-```
+```diff
     ...
 
     'disks' => [
 
         'local' => [
             'driver' => 'local',
-            'root'   => storage_path('app'),
-            'url' => 'storage/app/',
+            'root' => storage_path('app'),
++           'url' => 'storage/app/',
         ],
 
     ],
@@ -64,4 +70,5 @@ Here you can see some basic examples of how to use this plugin. Out of the box,
 
 ## Questions? Need help?
 
-If you have any question about how to use this plugin, please don't hesitate to contact us at octobercms@vdlp.nl. We're happy to help you. You can also visit the support forum and drop your questions/issues there.
+If you have any question about how to use this plugin, please don't hesitate to contact us at octobercms@vdlp.nl. 
+We're happy to help you. You can also visit the support forum and drop your questions/issues there.

updates/version.yaml

@@ -4,3 +4,4 @@
 2.0.0: !!! October Build 1.1.0 required, make laravel 6 compatible.
 2.0.1: Update plugin dependencies
 3.0.0: !!! Drop support for PHP 7.1 (minimum required PHP version 7.4) - Review implementation (see README.md)
+3.0.1: Add missing CHANGELOG file