Removed gravatar() and gravatar_profile() helpers functions

CHANGELOG.md

@@ -1,13 +1,21 @@
 CHANGELOG
 =========
 
+4.0.0 (2023-03-16)
+------------------
+
+- Removed `gravatar()` and `gravatar_profile()` helpers functions
+- Added documentation to implement own helpers
+
+
 3.0.1 (2023-03-16)
 ------------------
 
 - Added UPGRADE.md
 - Improved README.md file
 - Uppercased "README" and "CHANGELOG" files
 
+
 3.0.0 (2023-03-16)
 ------------------
 

README.md

@@ -81,7 +81,7 @@ Usage
 
 There are many ways to use this library:
 
-- Use helpers fonctions `gravatar()` and `gravatar_profile()`
+- Use helpers fonctions
 - Use the Gravatar base class with its `Gravatar::image()` and `Gravatar::profile()` methods
 - Instantiate the dedicated classes `Gravatar\Image()` and `Gravatar\Profile()`
 
@@ -93,6 +93,45 @@ Whatever method you use, you could use the `url()` method to retrieve it. Or dis
 
 The easiest way to use this library is to use the helper functions.
 
+Since version 4, in order to avoid conflicts with other packages, we no longer define the `gravatar()` and `gravatar_profile()` helpers. It's up to you to do this in your app with names that work for you and don't conflict with others. Here's how to do it; it's simple.
+
+In a file dedicated to the helper functions, define the version 3 functions using the names that suit you.
+
+```php
+<?php
+
+use Gravatar\Image;
+use Gravatar\Profile;
+
+if (! function_exists('gravatar')) {
+    /**
+     * Return a new Gravatar Image instance.
+     *
+     * @param string|null $email
+     * @return Image
+     */
+    function gravatar(?string $email = null): Image
+    {
+        return new Image($email);
+    }
+}
+
+if (! function_exists('gravatar_profile')) {
+    /**
+     * Return a new Gravatar Profile instance.
+     *
+     * @param string|null $email
+     * @return Profile
+     */
+    function gravatar_profile(?string $email = null): Profile
+    {
+        return new Profile($email);
+    }
+}
+```
+
+This way you can use them like this:
+
 ```php
 <?php
 require 'vendor/autoload.php';

UPGRADE.md

@@ -1,6 +1,16 @@
 UPGRADE
 =======
 
+From 3.x to 4.x
+---------------
+
+In version 3 I introduced 2 helpers `gravatar()` and `gravatar_profile()` but it was a bad idea.
+
+The `gravatar()` and `gravatar_profile()` helpers have been removed from the package because they could conflict with other global functions of the same name.
+
+I prefer to indicate how to define your own helpers rather than embedding them "hard" in the package.
+
+
 From 2.x to 3.x
 ---------------
 

composer.json

@@ -17,10 +17,7 @@
 	"autoload" : {
 		"psr-4" : {
 			"Gravatar\\" : "src"
-		},
-        "files": [
-            "src/helpers.php"
-        ]
+		}
 	},
 	"minimum-stability" : "dev",
 	"support" : {