merkandi/laravel-5-robots

Robots.txt Generator for Laravel 5

0.2.0 2020-09-02 11:29 UTC

This package is not auto-updated.

Last update: 2022-08-04 20:00:50 UTC


README

Current Release Total Downloads Build Status Code Climate Test Coverage

This is a fork of https://github.com/jayhealey/Robots. It appears development has stalled on the original repository.

The purpose of this fork is to introduce Laravel 5 compatibility and PSR-4 and PSR-2 (for Laravel 5.1).

Installation

Step 1: Composer

Add the package to your composer.json:

{
    "require": {
        "merkandi/laravel-5-robots": "~0.1.0"
    }
}

Step 2: Configuration

Add the following to your config/app.php in the providers array:

'EllisTheDev\Robots\RobotsServiceProvider',

You can also optionally add the following to the aliases array:

'Robots' => 'EllisTheDev\Robots\RobotsFacade',

Usage

Add the following to your routes file:

Route::get('robots.txt', function ()
{
    if (App::environment() == 'production') {
        // If on the live server, serve a nice, welcoming robots.txt.
        Robots::addUserAgent('*');
        Robots::addSitemap('sitemap.xml');
    } else {
        // If you're on any other server, tell everyone to go away.
        Robots::addDisallow('*');
    }

    return Response::make(Robots::generate(), 200, ['Content-Type' => 'text/plain']);
});

Refer to the Robots.php for API usage.

License

MIT