doc: README

Author: MasterRO94

README.md

@@ -20,113 +20,114 @@
     </a>
 </p>
 
-# Mail logger and viewer for Laravel
+# Laravel Mail Logger & Viewer
 
-### Easily log, view and search in browser all outgoing emails.
+Easily log, view, and search outgoing emails directly in your browser.
 
-![preview](https://github.com/MasterRO94/packages/blob/master/mail-viewer/Mail%20Viewer%20V2.png "Preview")
+![Preview Dark](./art/v3-dark.png "Preview Dark")
+![Preview Light](./art/v3-light.png "Preview Light")
 
-This package gives an ability to log all outgoing emails to a database and view them all from a browser like they will
-be shown in a modern mail clients (gmail, etc.).
+This package logs all outgoing emails to a database and provides a web interface to view them, formatted as they appear in modern email clients like Gmail.
 
-## Version Compatibility
+---
 
-| Laravel     | Mail Viewer |
-|:------------|:------------|
-| 5.5.x - 8.* | 1.3.x       |
-| 9.x - 12.x  | 2.x.x       |
-| 12.x        | 3.x.x       |
-
-## Upgrade from v1 to v2
-
-Version 2 has been almost totally rewritten and brings totally new fresh UI build with Vue.js 3 and TailwindCss 3.  
-It works **only with Laravel 9+** as of Symfony Mailer replacement for previously used Swift Mailer.
+## Installation
 
-### Upgrade Steps
+### Step 1: Install via Composer
 
-#### Composer Dependencies
+Run the following command in your terminal:
 
-You should update the dependency in your application's composer.json file:
+```sh
+composer require masterro/laravel-mail-viewer
+```
 
-`masterro/laravel-mail-viewer` to ^2.0
+### Step 2: Publish Assets & Configurations
 
-#### Database migrations
+```sh
+php artisan mail-viewer:publish
+```
 
-Run package migrations (requires `doctrine/dbal` to be installed):
+### Step 3: Run Migrations
 
-```shell
+```sh
 php artisan migrate
 ```
 
-#### Publish assets
+### Step 4: View Emails
 
-Run publish command:
+Visit `/_mail-viewer` in your browser to access the email viewer.
 
-```shell
-php artisan mail-viewer:publish --views
-```
+> **Note:** The route can be customized in the configuration file.
 
-#### Update configs
+---
 
-V2 uses separate date format for date and time, update these in your `config/mail-viewer.php` file
+## Configuration
 
-```php
-'date_format' => 'd.m.Y',
-'time_format' => 'H:i:s',
-```
+You can adjust default settings in the `config/mail-viewer.php` file.
 
-#### Data pruning
+### Data Pruning
 
-V2 allows prune old records easily using `mail-viewer:prune` command. You can add it to your Scheduler.
+The package supports Laravel's [Model Pruning](https://laravel.com/docs/eloquent#pruning-models). Define how many days emails should be retained in the configuration:
 
 ```php
-// Console/Kernel.php
-$schedule->command('mail-viewer:prune')->daily();
+'prune_older_than_days' => 365,
 ```
 
-You can specify how many days data will be stored before pruning using config. Default value is 31 days.
+---
 
-```php
-'prune_older_than_days' => 31,
-```
+## Production Usage
 
-## Installation
+By default, the email viewer is publicly accessible. 
+In a production environment, it's highly recommended to restrict access 
+using middleware or something like [Access Screen](https://github.com/MasterRO94/laravel-access-screen) package.
 
-### Step 1: Composer
+### Restrict Access with Middleware
 
-From the command line, run:
+Modify your `routes/web.php` to apply authentication:
 
-```
-composer require masterro/laravel-mail-viewer
+```php
+'middleware' => ['web', 'can:viewMailLogs'],
 ```
 
-### Step 2: Publish assets and configs
+You can also limit access by IP address in `App\Http\Middleware\RestrictMailViewerAccess.php`:
 
-```
-php artisan mail-viewer:publish
+```php
+namespace App\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+
+class RestrictMailViewerAccess
+{
+    public function handle(Request $request, Closure $next)
+    {
+        if (!in_array($request->ip(), ['127.0.0.1', '::1', 'YOUR_ALLOWED_IP'])) {
+            abort(403);
+        }
+
+        return $next($request);
+    }
+}
 ```
 
-You have to publish _**assets,**_ and _**views,**_ _configs_ are optional.
+Apply it in config:
 
-### Step 3: Run migrations
+```php
 
-```
-php artisan migrate
+'middleware' => ['web', RestrictMailViewerAccess::class],
 ```
 
-### Step 4: View emails
+Now, only authorized users or allowed IPs can access the mail viewer.
 
-All ongoing emails you can find on `/_mail-viewer` page.
+---
 
-## Configuration
+## License
 
-You can review and change all the default configuration values in published `config/mail-viewer.php` file.
+This package is open-source software licensed under the [MIT license](LICENSE).
 
-#### Data pruning (v2+)
+---
 
-The package allows you to prune old records easily using `mail-viewer:prune` command. You can add it to your Scheduler.
+## Credits
+
+Developed by [MasterRO](https://github.com/MasterRO94).
 
-```php
-// Console/Kernel.php
-$schedule->command('mail-viewer:prune')->daily();
-```