diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b50c3e..86f8529 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ All notable changes to the Laravel Mail Viewer be documented in this file +## v1.0.1 (20-09-2018) +- Updated readme + ## v1.0.0 (19-09-2018) - Added Tests - First major stable release diff --git a/README.md b/README.md index 0bb0586..e8d929a 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,8 @@ return [ | URL where you want to view the mails |-------------------------------------------------------------------------- | - | This is the URL where you can view all the mailables - | registered in your application. + | This is the URL where you can view all the + | mailables registered above. | */ @@ -64,7 +64,7 @@ return [ | */ - 'allowed_environments' => ['local', 'staging'], + 'allowed_environments' => ['local', 'staging', 'testing'], /* |-------------------------------------------------------------------------- @@ -83,6 +83,20 @@ return [ ]; ``` +## How to use + +- After setting up the config values as described above, you can see the list of all mailables by visiting the `/mails` route (considering the default url is 'mails' in the config file). You can modify it to whatever you want as per your needs. + +- You can also restrict the environments the package should list the mailables in. By default, the `allowed_environments` config is set to allow 3 environments: `local`, `staging` & `testing`. You can further secure it using the `middlewares` config. + +- Default view: + +List of all mails | A particular mail rendered +:-------------------------:|:-------------------------: +![](https://user-images.githubusercontent.com/11228182/45781093-bb59ef00-bc7c-11e8-9d03-64cf245fd82c.png) | ![](https://user-images.githubusercontent.com/11228182/45780701-c3fdf580-bc7b-11e8-9f48-0d883a640010.png) + +- This package supports the option of overriding the package views that Laravel provides. You can modify the view using [these instructions from the Larvel docs](https://laravel.com/docs/packages#views), as per your needs. + ## Testing You can run the tests with: