docs: installation and usage

Author: JamesHemery

README.md

@@ -14,9 +14,89 @@ If you're just looking for a mailjet mail transport, check out [mailjet/laravel-
 
 	composer require yieldstudio/laravel-mailjet-notifier
 
+## Configure
+
+Just define these environment variables:
+
+```dotenv
+MAILJET_APIKEY=
+MAILJET_APISECRET=
+MAILJET_SMSTOKEN=
+MAIL_FROM_ADDRESS=
+MAIL_FROM_NAME=
+MAILJET_SMS_SENDER=
+```
+
+Make sure that MAIL_FROM_ADDRESS is an authenticated email on Mailjet, otherwise your emails will not be sent by the Mailjet API.
+
+MAILJET_SMS_SENDER should be between 3 and 11 characters in length, only alphanumeric characters are allowed.
+
+You can publish the configuration file with:
+
+```shell
+php artisan vendor:publish --provider="YieldStudio\LaravelMailjetNotifier\MailjetNotifierServiceProvider" --tag="config"
+```
+
 ## Usage
 
-TODO
+### Send email
+
+```php
+<?php
+
+namespace App\Notifications;
+
+use Illuminate\Notifications\Notification;
+use YieldStudio\LaravelMailjetNotifier\MailjetEmailChannel;
+
+class OrderConfirmation extends Notification
+{
+    public function channels(): array
+    {
+        return [MailjetEmailChannel::class];
+    }
+
+    public function toMailjetEmail($notifiable): MailjetEmailMessage
+    {
+        return (new MailjetEmailMessage())
+            ->templateId(999999) // Replace with your template ID
+            ->to($notifiable->firstname, $notifiable->email)
+            ->variable('firstname', $notifiable->firstname)
+            ->variable('order_ref', 'N°0000001');
+    }
+}
+```
+
+### Send sms
+
+```php
+<?php
+
+namespace App\Notifications;
+
+use Illuminate\Notifications\Notification
+;use YieldStudio\LaravelMailjetNotifier\MailjetSmsChannel;
+use YieldStudio\LaravelMailjetNotifier\MailjetSmsMessage;
+
+class ResetPassword extends Notification
+{
+    public function __construct(protected string $code)
+    {
+    }
+
+    public function via()
+    {
+        return [MailjetSmsChannel::class];
+    }
+
+    public function toMailjetSms($notifiable): MailjetSmsMessage
+    {
+        return (new MailjetSmsMessage())
+            ->to($notifiable->phone)
+            ->text(__('This is your reset code :code', ['code' => $this->code]));
+    }
+}
+```
 
 ## Unit tests
 

src/MailjetNotifierServiceProvider.php

@@ -13,7 +13,7 @@ public function boot(): void
         if ($this->app->runningInConsole()) {
             $this->publishes([
                 __DIR__.'/../config' => config_path(),
-            ], 'mailjet-notifier-config');
+            ], 'config');
         }
     }