doc: update README and CHANGELOG

Author: Karel FAILLE

CHANGELOG.md

@@ -1,8 +1,12 @@
 # Changelog
 
-All notable changes to `laravel-mail-log-channel` will be documented in this file
+All notable changes to `laravel-mail-log-channel` will be documented in this file.
 
-## 1.1.0 - 2020-01-29
+## 2.0.1 - 2020-02-21
+
+- support multiple `to` configuration formats
+
+## 2.0.0 - 2020-01-29
 
 - add support for Laravel 6 and 7 (thanks to @jbeales https://github.com/designmynight/laravel-log-mailer/pull/7)
 - remove extra configuration and view files

README.md

@@ -1,5 +1,5 @@
-Laravel Mail Logger
-===============
+# Laravel Mail Log Channel
+
 
 [![Latest Stable Version](https://img.shields.io/github/v/release/shaffe-fr/laravel-mail-log-channel.svg)](https://packagist.org/packages/shaffe/laravel-mail-log-channel) [![Total Downloads](https://img.shields.io/packagist/dt/shaffe/laravel-mail-log-channel.svg)](https://packagist.org/packages/shaffe/laravel-mail-log-channel)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -10,30 +10,27 @@ This package is a fork of [laravel-log-mailer](https://packagist.org/packages/de
 
 ![image](https://user-images.githubusercontent.com/12199424/45576336-a93c1300-b86e-11e8-9575-d1e4c5ed5dec.png)
 
+## Table of contents
 
-Table of contents
------------------
 * [Installation](#installation)
 * [Configuration](#configuration)
 
-Installation
-------------
+## Installation
 
 You can install this package via composer using this commande:
 
 ```sh
 composer require shaffe/laravel-mail-log-channel
 ```
 
-
-### Laravel version Compatibility
+### Laravel version compatibility
 
  Laravel  | Package |
 :---------|:--------|
- 7.x      | 1.1.x   |
- 6.x      | 1.1.x   |
- 5.6.x    | 1.0.x   |
- 
+ 7.x      | ^2.0   |
+ 6.x      | ^2.0   |
+ 5.6.x    | ^1.0   |
+
 The package will automatically register itself if you use Laravel.
 
 For usage with [Lumen](http://lumen.laravel.com), add the service provider in `bootstrap/app.php`.
@@ -42,15 +39,16 @@ For usage with [Lumen](http://lumen.laravel.com), add the service provider in `b
 $app->register(Shaffe\MailLogChannel\MailLogChannelServiceProvider::class);
 ```
 
-Configuration
-------------
+## Configuration
 
 To ensure all unhandled exceptions are mailed:
 
 1. create a `mail` logging channel in `config/logging.php`,
 2. add this `mail` channel to your current logging stack,
 3. add a `LOG_MAIL_ADDRESS` to your `.env` file to define the recipient.
 
+You can specify multiple channels and individually change the recipients, the subject and the email template.
+
 ```php
 'channels' => [
     'stack' => [
@@ -66,21 +64,23 @@ To ensure all unhandled exceptions are mailed:
         'driver' => 'mail',
         'level' => env('LOG_MAIL_LEVEL', 'notice'),
 
-        // Specify who to mail the log to
+        // Specify mail recipient
         'to' => [
             [
                 'address' => env('LOG_MAIL_ADDRESS'),
-                'name' => 'Error'
-            ]
+                'name' => 'Error',
+            ],
         ],
 
         'from' => [
+            // Defaults to config('mail.from.address')
             'address' => env('LOG_MAIL_ADDRESS'),
+            // Defaults to config('mail.from.name')
             'name' => 'Errors'
         ],
 
         // Optionally overwrite the subject format pattern
-        'subject_format' => env('LOG_MAIL_SUBJECT_FORMAT', '[%datetime%] %level_name%: %message%'),
+        // 'subject_format' => env('LOG_MAIL_SUBJECT_FORMAT', '[%datetime%] %level_name%: %message%'),
 
         // Optionally overwrite the mailable template
         // Two variables are sent to the view: `string $content` and `array $records`
@@ -89,6 +89,8 @@ To ensure all unhandled exceptions are mailed:
 ],
 ```
 
+### Recipients configuration format
+
 The following `to` config formats are supported:
 
 * single email address:
@@ -103,13 +105,13 @@ The following `to` config formats are supported:
     'to' => explode(',', env('LOG_MAIL_ADDRESS', '')),
     ```
 
-* associative array of email/name addresses:
+* associative array of email => name addresses:
 
     ```php
     'to' => [env('LOG_MAIL_ADDRESS', '') => 'Error'],`
     ```
 
-* an array of email and name:
+* array of email and name:
 
     ```php
     'to' => [
@@ -119,5 +121,3 @@ The following `to` config formats are supported:
          ],
      ],
     ```
-
-You can specify multiple channels and change the recipients and customize the email template per channel.