benmag/laravel-namor

A domain-safe name generator

dev-master / 1.0.x-dev 2018-02-11 22:41 UTC

Requires

• php: ~7.0

MIT

• Ben Mag

• benmag
• name generator

README

Namor - A domain-safe name generator

This package is based on the Namor package by jsonmaur.

Getting started

Install via Composer

composer install benmag/laravel-namor

Register service provider Add the NamorServiceProvider to your config/app.php file in the providers key

'providers' => [
    // ... other providers
    Benmag\Namor\NamorServiceProvider::class,
]

Usage

use Benmag\Namor\Namor;

Namor::generate([number of words], [number of trailing numbers], [seperator character]);

// Defaults to 2 words and 4 trailing numbers
Namor::generate()

// Generate with 3 words and no numbers
Namor::generate(3, 0);

Configuration

You may also publish the config file to config/namor.php which will let you customise the words used to generate the names.

php artisan vendor:publish --provider="Benmag\Namor\NamorServiceProvider"

License

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