diff --git a/readme.md b/readme.md index 13b2608..4c8c1f3 100644 --- a/readme.md +++ b/readme.md @@ -31,43 +31,43 @@ This will publish a file `modelmediabackup.php` in your config directory with th ```php return [ /* - * Models from which you want to take media for backup - */ - 'Models' => [ - // Example 'App\User' - ], - - /* - * Backup FILESYSTEM_DRIVER name on which you want to take backup - */ - 'BACKUP_DISK' => null, // FILESYSTEM_DRIVER - + * Models from which you want to take media for backup + */ + 'models' => [ + // Example 'App\User' + ], + + /* + * Backup FILESYSTEM_DRIVER name on which you want to take backup + */ + 'backup_disk' => null, // FILESYSTEM_DRIVER + + /* + * Number of records to be chunk in backup process + */ + 'chunk_size' => 100, + + /* + * Notification configuration + */ + 'notification' => [ + /* - * Number of records to be chunk in backup process + * Email address where you want to receive email alert */ - 'ChunkSize' => 100, + 'mail_to' => null, /* - * Notification configuration + * Here you can specify the notifiable to which the notifications should be sent. The default + * + * notifiable will use the variables specified in this config file. */ - 'Notification' => [ - - /* - * Email address where you want to receive email alert - */ - 'MailTo' => null, - - /* - * Here you can specify the notifiable to which the notifications should be sent. The default - * - * notifiable will use the variables specified in this config file. - */ - 'notifiable' => \BinBytes\ModelMediaBackup\Notifications\Notifiable::class, - - 'Notifications' => [ - \BinBytes\ModelMediaBackup\Notifications\Notifications\MediaBackupSuccessful::class, - ] - ] + 'notifiable' => \BinBytes\ModelMediaBackup\Notifications\Notifiable::class, + + 'notifications' => [ + \BinBytes\ModelMediaBackup\Notifications\Notifications\MediaBackupSuccessful::class, + ], + ], ]; ``` ## Usage