more docs

axyr · Jul 4, 2024 · 4218208 · 4218208
1 parent c5ab84d
commit 4218208
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/docs/installation.md b/docs/installation.md
@@ -15,7 +15,7 @@ Publish the database migration and configuration file:
 php artisan vendor:publish --provider="Axyr\EmailViewer\EmailViewerServiceProvider"
 ```
 
-By default the package provides a set of routes for the Blade UI and the Vue UI. You can disabled them in the config file.
+By default this package provides a set of routes for the Blade UI and the Vue UI. You can disabled them in the config file.
 
 You can access the Blade UI by visiting:
 

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1 +1,16 @@
 # Introduction
+
+This package allows copying and viewing all outgoing emails locally from your Laravel application.
+
+This can be used in production to ensure you application actually sent the emails.
+For example when users say they did not receive an email and you want to verify the email was sent from the application.
+
+But this package can also replace tools like Mailhog or Mailtrap to inspect emails sent from test or staging environments.
+Sometimes you might want to or are not allowed to using an external service to catch emails.
+
+In that case you will probably use the ``log`` or ``array`` mail driver to ensure emails will never leave the system.
+
+To make inspecting those emails easier or allow test users to view the emails in the application, you can use this package to inspect and test emails in your non-local and non-production environments.
+In this way, can still test features like password reset or other transactional email features.
+
+![](img/screenshot.png)
diff --git a/docs/laravel-email-viewer.md b/docs/laravel-email-viewer.md
@@ -2,7 +2,7 @@
 
 View and inspect all emails sent from your Laravel application.
 
-![](docs/img/mailboxes.png)
+![](img/mailboxes.png)
 
 Laravel Email Viewer is a package that allows you to view all emails sent from you application in the browser. This allows you to ensure your application has actually sent the mail. When using log as
 an email driver for your local or staging environment, you can inspect emails without the need for external tools like Mailtrap or Mailhog, so emails never have to leave your server at all.