From 8903f551c0b8eabbd77728ddadf47d5cefe6d615 Mon Sep 17 00:00:00 2001 From: "Endurance, the Martian" Date: Fri, 29 Dec 2023 21:02:07 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=A6=20changes:=20added=20tests=20for?= =?UTF-8?q?=20gravatar=20&=20doc=20rewrite=20(added=20alert)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5422948..fbb998b 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ | UI Avatars | UI Avatars is an avatar library for designers and developers. | Yes ✅️ | [UI Avatars](https://ui-avatars.com/) | | Boring Avatar | Boring avatars is a tiny JavaScript React library that generates custom, SVG-based, round avatars from any username and color palette. | Yes ✅️ | [Boring Avatar](https://boringavatars.com/) | -> Note: You can also add your own custom driver by implementing the `AmplifiedHQ\Laravatar\Contracts\AvatarInterface;` interface and extending the `AmplifiedHQ\Laravatar\Abstracts\BaseAvatar` class. +> [!NOTE] +> You can also add your own custom driver by implementing the `AmplifiedHQ\Laravatar\Contracts\AvatarInterface;` interface and extending the `AmplifiedHQ\Laravatar\Abstracts\BaseAvatar` class. @@ -95,7 +96,8 @@ class User extends Authenticatable > [!IMPORTANT] > If you are using the `gravater` driver, you need to use the email column as the avatar column. If you are using the `dicebear` or `ui-avatars` or `boringavatar` driver, you can use any column as the avatar column, provided that the column is a string column. (e.g. `name`, `email`, `username` etc.) -> Note: The `HasAvatar` trait requires you to define the `$avatarColumn` and `$avatarStorageColumn` properties in your model. The `$avatarColumn` property is the column that will be used to generate the avatar. The `$avatarStorageColumn` property is the column that will be used to store the avatar. +> [!WARNING] +> The `HasAvatar` trait requires you to define the `$avatarColumn` and `$avatarStorageColumn` properties in your model. The `$avatarColumn` property is the column that will be used to generate the avatar. The `$avatarStorageColumn` property is the column that will be used to store the avatar. ### Using the Driver Methods You can also use each driver method directly on your application either on on your controller, model or view.