olssonm/l5-humans

Simple humans.txt routes and views for Laravel 5.

v5.0 2019-11-01 16:26 UTC

This package is auto-updated.

Last update: 2020-06-30 01:11:17 UTC


README

Latest Version on Packagist Software License Build Status

l5-humans

Stop polluting your customers footers with a "made by my agency so I put a cheap link in the footer"-link – that footer is your customers property. Instead, if you want credit – add a simple humans.txt.

All this package does is to add a route for /humans.txt and the associated view. "Why would I ever need a package for a simple thing like this?" you wonder? Well, so did I until I had done it over 20-30 times – it just saves a few minutes which adds up over time.

Version Compatibility

See COMPATABILITY.md for full a full compatability chart. Else Composer should be able to figure it out by itself.

Install

Install via composer:

$ composer require olssonm/l5-humans

Since Laravel > 5.5 the service provider will be automatically added. You can also add the service provider to your app.php manually:

'providers' => [
    Olssonm\Humans\ServiceProvider::class
]

Publish the view:

$ php artisan vendor:publish --provider="Olssonm\Humans\ServiceProvider"

Or by just typing:

$ php artisan vendor:publish

And selecting Olssonm\Humans\ServiceProvider.

Make it your own

The view is located in your views-folder /humans/humans.blade.php.

It's also valid to put this in your <head>:

<link type="text/plain" rel="author" href="http://domain.com/humans.txt" />

If you by any chance need to access your humans.txt via a named route, that's also possible:

<link type="text/plain" rel="author" href="{{ route('humans.txt') }}" />

Learn more

Learn more about the humans.txt-standard at humanstxt.org.

Testing

$ composer test

or

$ phpunit

License

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

© 2019 Marcus Olsson.