Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 2.55 KB

README.md

File metadata and controls

83 lines (63 loc) · 2.55 KB
Raw

Laravel Envicon

Support Laravel versions Latest Version on Packagist Software License GitHub Workflow Status

This package allows you to display a custom favicon depending on your runtime environment. This makes it easy to identify immediately on which environment you're browsing.

Install

Via Composer

composer require hedger/laravel-envicon

Once the package is installed, you'll need to publish the configuration to link your environments to custom favicons.

php artisan vendor:publish --tag=envicon-config

If you want to use the default envicons provided by this package, run the following command that will copy them in your public/favicons folder.

php artisan vendor:publish --tag=envicon-favicons

Usage

Simply use the provided helper in place of your favicon's URL. This will return the favicon that matches your current runtime environment.

<!doctype html>
<html lang="en">
    <head>
        <link rel="icon" href="{{ Envicon::url() }}">
    </head>
</html>

If you need the URL of a favicon for a specific environment, use the following statement instead. You'll need to pass the environment's name as the first parameter.

<!doctype html>
<html lang="en">
    <head>
        <link rel="icon" href="{{ Envicon::for('production') }}">
    </head>
</html>

Testing

Tests can be run using the following composer script.

composer test

License

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