wording and readme update

Author: marickvantuil

README.md

@@ -10,12 +10,28 @@
 ## Introduction
 
 This is a package that stores and queues e-mails using a database table. Easily send e-mails using a cronjob and schedule e-mails that should be sent at a specific date and time.
-## Installation
+
+## Table Of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Send an e-mail](#send-an-email)
+  - [Specify multiple recipients](#specify-multiple-recipients)
+  - [CC and BCC](#cc-and-bcc)
+  - [Mailables](#using-mailables)
+  - [Attachments](#attachments)
+  - [Custom sender](#custom-sender)
+  - [Scheduling](#scheduling)
+  - [Resend failed e-mails](#resend-failed-e-mails)
+  - [Encryption (optional)](#encryption-(optional))
+  - [Test mode (optional)](#test-mode-(optional))
+
+### Installation
 
 First, require the package using composer.
 
 ```bash
-$ composer require buildcode/laravel-database-emails
+composer require buildcode/laravel-database-emails
 ```
 
 If you're running Laravel 5.5 or later you may skip this step. Add the service provider to your application.
@@ -27,13 +43,13 @@ Buildcode\LaravelDatabaseEmails\LaravelDatabaseEmailsServiceProvider::class,
 Publish the configuration files.
 
 ```bash
-$ php artisan vendor:publish --provider=Buildcode\\LaravelDatabaseEmails\\LaravelDatabaseEmailsServiceProvider
+php artisan vendor:publish --provider=Buildcode\\LaravelDatabaseEmails\\LaravelDatabaseEmailsServiceProvider
 ```
 
 Create the database table required for this package.
 
 ```bash
-$ php artisan migrate
+php artisan migrate
 ```
 
 Now add the e-mail cronjob to your scheduler.
@@ -47,17 +63,19 @@ Now add the e-mail cronjob to your scheduler.
  */
 protected function schedule(Schedule $schedule)
 {
-     $schedule->command('email:send')->everyMinute();
+     $schedule->command('email:send')->everyMinute()->withoutOverlapping(5);
 }
 ```
 
-## Usage
+### Usage
 
-### Create An Email
+#### Send an email
 
 ```php
+use Buildcode\LaravelDatabaseEmails\Email;
+
 Email::compose()
-    ->label('welcome-mail-1.0')
+    ->label('welcome')
     ->recipient('[email protected]')
     ->subject('This is a test')
     ->view('emails.welcome')
@@ -67,90 +85,114 @@ Email::compose()
     ->send();
 ```
 
-### Specify Recipients
+#### Specify multiple recipients
 
 ```php
-$one = '[email protected]';
-$multiple = ['[email protected]', '[email protected]'];
+use Buildcode\LaravelDatabaseEmails\Email;
+
+Buildcode\LaravelDatabaseEmails\Email::compose()
+    ->recipient([
+        '[email protected]',
+        '[email protected]'
+    ]);
+```
 
-Email::compose()->recipient($one);
-Email::compose()->recipient($multiple);
+#### CC and BCC
 
-Email::compose()->cc($one);
-Email::compose()->cc($multiple);
+```php
+use Buildcode\LaravelDatabaseEmails\Email;
 
-Email::compose()->bcc($one);
-Email::compose()->bcc($multiple);
+Email::compose()
+    ->cc('[email protected]')
+    ->cc(['[email protected]', '[email protected]'])
+    ->bcc('[email protected]')
+    ->bcc(['[email protected]', '[email protected]']);
 ```
 
-### Mailables
+#### Using mailables
 
 You may also pass a mailable to the e-mail composer.
 
 ```php
+use Buildcode\LaravelDatabaseEmails\Email;
+
 Email::compose()
     ->mailable(new OrderShipped())
     ->send();
 ```
 
-### Attachments
+#### Attachments
 
 ```php
+use Buildcode\LaravelDatabaseEmails\Email;
+
 Email::compose()
     ->attach('/path/to/file');
 ```
 
-Or for in-memory attachments...
+Or for in-memory attachments:
 
 ```php
+use Buildcode\LaravelDatabaseEmails\Email;
+
 Email::compose()
     ->attachData('<p>Your order has shipped!</p>', 'order.html');
 ```
 
-### Custom Sender
+#### Custom Sender
 
 ```php
+use Buildcode\LaravelDatabaseEmails\Email;
+
 Email::compose()
     ->from('[email protected]', 'John Doe');
 ```
 
-### Schedule An Email
+#### Scheduling
 
-You may schedule an e-mail by calling `later` instead of `send` at the end of the chain. You must provide a Carbon instance or a strtotime valid date.
+You may schedule an e-mail by calling `later` instead of `send`. You must provide a Carbon instance or a strtotime valid date.
 
 ```php
+use Buildcode\LaravelDatabaseEmails\Email;
+
 Email::compose()
     ->later('+2 hours');
 ```
 
-### Manually Sending E-mails
+#### Resend failed e-mails
 
-If you're not running the cronjob and wish to send the queued e-mails, you can run the `email:send` command.
+##### Resend all failed e-mails
 
 ```bash
-$ php artisan email:send
+php artisan email:retry
 ```
 
-### Failed E-mails
-
-By default, we will attempt to send an e-mail 3 times if it fails. If it still fails the 3rd time, it will permanently be marked as failed. You can change the number of times an e-mail should be attempted to be sent using the `retry.attempts` configuration.
-
-### Retry sending failed e-mails
-
-If you wish to retry sending failed e-mails, you may call the `email:retry` command. The command will grab any failed e-mail and push it onto the queue. You may also provide the id of a specific e-mail.
+##### Resend a specific failed e-mail
 
 ```bash
-$ php artisan email:retry
-# or...
-$ php artisan email:retry 1
+php artisan email:retry 1
 ```
 
-### Encryption
+#### Encryption (Optional)
+
+If you wish to encrypt your e-mails, please enable the `encrypt` option in the configuration file. This is disabled by default. Encryption and decryption will be handled by Laravel's built-in encryption mechanism. Please note that by encrypting the e-mail it takes more disk space.
 
-If you wish to encrypt your e-mails, please enable the `encrypt` option in the configuration file. This is disabled by default. Encryption and decryption will be handled by Laravel's built-in encryption mechanism. Please note that encrypting the e-mail body takes a lot of disk space.
+```text
+Without encryption
 
-### Testing Address
+7    bytes (label)
+16   bytes (recipient)
+20   bytes (subject)
+48   bytes (view name)
+116  bytes (variables)
+1874 bytes (e-mail content)
+4    bytes (attempts, sending, failed, encrypted)
+57   bytes (created_at, updated_at, deleted_at)
+... x 10.000 rows = ± 21.55 MB
+
+With encryption the table size is ± 50.58 MB.
+```
 
-If you wish to send e-mails to a test address but don't necessarily want to use a service like mailtrap, please take a look at the `testing` configuration. This is turned off by default.
+#### Test mode (Optional)
 
-During the creation of an e-mail, the recipient will be replaced by the test e-mail. This is useful for local development or testing on a staging server.
+When enabled, all newly created e-mails will be sent to the specified test e-mail address. This is turned off by default.

config/laravel-database-emails.php

@@ -4,29 +4,24 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Retry Mode
+    | Attempts
     |--------------------------------------------------------------------------
     |
-    | Here you may specify the number of attempts the cronjob should get
-    | to send an email. If the sending fails after the number of max
-    | tries, we will no longer attempt to send that e-mail.
+    | Here you may specify the number of times the cronjob will try to send an e-mail.
+    | Once the max attempt count is reached, the e-mail will be marked as failed
+    | and will no longer be sent.
     |
     */
 
-    'retry' => [
-
-        'attempts' => 3,
-
-    ],
+    'attempts' => 3,
 
     /*
     |--------------------------------------------------------------------------
     | Encryption
     |--------------------------------------------------------------------------
     |
-    | Here you may enable encryption for all e-mails. If enabled, we
-    | will automatically encrypt all the view data, recipient and
-    | decrypt it during the sending phase.
+    | Here you may enable encryption for all e-mails. The e-mail will be encrypted according
+    | your application's configuration (OpenSSL AES-256-CBC by default).
     |
     */
 
@@ -37,9 +32,9 @@
     | Test E-mail
     |--------------------------------------------------------------------------
     |
-    | When developing the application or testing on a staging server you may
-    | wish to send all e-mails to a specific test inbox. If enabled, all
-    | recpient emails will be hijacked and sent to the test address.
+    | When developing your application or testing on a staging server you may
+    | wish to send all e-mails to a specific test inbox. Once enabled, every
+    | newly created e-mail will be sent to the specified test address.
     |
     */
 
@@ -60,9 +55,9 @@
     | Cronjob Limit
     |--------------------------------------------------------------------------
     |
-    | Limit the number of e-mails the cronjob may send at a time. This is useful
-    | if you want to prevent overlapping cronjobs. Keep in mind we already
-    | handle overlapping gracefully, however setting a limit is adviced.
+    | Limit the number of e-mails that should be sent at a time. Please ajust this
+    | configuration based on the number of e-mails you expect to send and
+    | the throughput of your e-mail sending provider.
     |
     */
 

src/Config.php

@@ -11,7 +11,7 @@ class Config
      */
     public static function maxAttemptCount()
     {
-        return max(config('laravel-database-emails.retry.attempts', 1), 3);
+        return max(config('laravel-database-emails.attempts', 1), 3);
     }
 
     /**

tests/TestCase.php

@@ -78,7 +78,7 @@ protected function getPackageProviders($app)
      */
     protected function getEnvironmentSetUp($app)
     {
-        $app['config']->set('laravel-database-emails.retry.attempts', 3);
+        $app['config']->set('laravel-database-emails.attempts', 3);
 
         $app['config']->set('database.default', 'testbench');
         $app['config']->set('database.connections.testbench', [