Merge pull request #31 from stackkit/readme

Readme

Author: marickvantuil

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 4.2.0 - 2020-05-16
+
+**Added**
+
+- Support for Laravel 7.x
+- Queued option
+
 ## 4.1.1 - 2020-01-11
 
 **Fixed**

README.md

@@ -17,6 +17,19 @@ The package is MIT licenced, meaning it's open source and you are free to copy o
 
 We feel the package is currently feature complete, but feel free to send a pull request or help improve existing code.
 
+# Requirements
+
+This package requires Laravel 5.6 or higher.
+
+Please check the table below for supported Laravel and PHP versions:
+
+|Laravel Version| PHP Version |
+|---|---|
+| 5.6 | 7.2 or 7.3
+| 5.7 | 7.2 or 7.3
+| 5.8 | 7.2 or 7.3 or 7.4
+| 6.x | 7.2 or 7.3 or 7.4
+| 7.x | 7.2 or 7.3 or 7.4
 
 # Installation
 
@@ -26,12 +39,6 @@ Require the package using composer.
 composer require stackkit/laravel-database-emails
 ```
 
-If you're running Laravel 5.5 or later you may skip this step. Add the service provider to your application.
-
-```
-Stackkit\LaravelDatabaseEmails\LaravelDatabaseEmailsServiceProvider::class,
-```
-
 Publish the configuration files.
 
 ```bash
@@ -190,6 +197,32 @@ Without encryption
 With encryption the table size is ± 50.58 MB.
 ```
 
+
+### Queueing e-mails
+
+**Important**: When queueing mail using the `queue` function, it is no longer necessary to schedule the `email:send` command. Please make sure it is removed from `app/Console/Kernel.php`.
+
+```php
+<?php
+
+use Stackkit\LaravelDatabaseEmails\Email;
+
+Email::compose()
+    ->queue();
+
+// on a specific connection
+Email::compose()
+    ->queue('sqs');
+
+// on a specific queue
+Email::compose()
+    ->queue(null, 'email-queue');
+
+// timeout (send mail in 10 minutes)
+Email::compose()
+    ->queue(null, null, now()->addMinutes(10));
+```
+
 ### Test mode (Optional)
 
 When enabled, all newly created e-mails will be sent to the specified test e-mail address. This is turned off by default.