GITBOOK-1: No subject

README.md

@@ -1,41 +1,41 @@
+---
+description: View and inspect all emails sent from your Laravel application.
+---
+
 # 📨 Laravel Email Viewer
 
-View and inspect all emails sent from your Laravel application.
+
 
 ![docs/img/screenshot.png](docs/img/screenshot.png)
 
 ## Introduction
 
-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.
+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.
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/axyr/laravel-email-viewer.svg?style=flat-square)](https://packagist.org/packages/axyr/laravel-email-viewer)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/spatie/laravel-permission/run-tests-L8.yml?branch=main&label=Tests)](https://github.com/axyr/laravel-email-viewer/actions?query=workflow%3ATests+branch%3Amain)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/axyr/laravel-email-viewer.svg?style=flat-square)](https://packagist.org/packages/axyr/laravel-email-viewer) [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/spatie/laravel-permission/run-tests-L8.yml?branch=main\&label=Tests)](https://github.com/axyr/laravel-email-viewer/actions?query=workflow%3ATests+branch%3Amain)
 
 ## Key features
 
-- Log all application emails to a storage disk or database table
-- Inspect HTML, attachments and email headers
-- Packed with a simple Blade UI and a Vue.js/JSON controller
-- Easily integrate in your existing application
+* Log all application emails to a storage disk or database table
+* Inspect HTML, attachments and email headers
+* Packed with a simple Blade UI and a Vue.js/JSON controller
+* Easily integrate in your existing application
 
 ## Quick start
 
-Run the composer install command:
+Run the composer install command from the terminal:
 
-```php 
+```php
 composer require axyr/laravel-email-viewer
 ```
 
 Publish the database migration and configuration file:
 
-```php 
+```php
  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 the 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:
 
@@ -46,9 +46,9 @@ https://your-host.tld/emails
 To send a test email the package provides a Test command:
 
 ```php
- php artisan email-viewer:send-test
+php artisan email-viewer:send-test
 ```
 
 For further information and customisation, visit our documentation page:
 
-https://axyr.gitbook.io/laravel-email-viewer
+[https://axyr.gitbook.io/laravel-email-viewer](https://axyr.gitbook.io/laravel-email-viewer)

docs/SUMMARY.md

@@ -1,5 +1,6 @@
-# Summary
+# Table of contents
 
+* [📨 Laravel Email Viewer](../README.md)
 * [Introduction](introduction.md)
 * [Requirements](requirements.md)
 * [Installation](installation.md)