README

This is a simple package to display MOTD messages to your users, it can be used to display updates, maintenance messages, or any other message you want to display to your users.

When using the package, simply call the get method on the motd model and it'll return the newest message that is not expired.

Installation

You can install the package via composer:

composer require lexiandev/laravel-motd

You can publish and run the migrations with:

php artisan vendor:publish --tag="motd-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="motd-config"

This is the contents of the published config file:

return [
    /**
     * The default text that will be displayed if no MOTD is set.
     * Default: Null; no message will be returned.
     */
    'default_message' => null,
];

Usage

$motd = new Motd();
return $motd->get();

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

lexiandev / laravel-motd

Maintainers

Details