laravel-junkies/url-shortener

The official UX9 URL Shortener API for Laravel Users.

v1.0.1 2019-03-23 21:43 UTC

This package is auto-updated.

Last update: 2021-10-24 03:14:56 UTC


README

The official UX9 URL Shortener API for Laravel Users. NOTE: a UX9 API Key is required.

Total Downloads Latest Stable Version Latest Unstable Version License

Installation

To get the latest version of Laravel Junkies UX9-URL-Shortener, you can use the Composer require command:

$ composer require laravel-junkies/url-shortener

If you want to install a specific version, update your require block and run composer update:

{
    "require": {
        "laravel-junkies/url-shortener": "^2.0"
    }
}

Once Laravel Junkies UX9-URL-Shortener is installed, you need to register the service provider in config/app.php. Add the following to providers:

  • LaraJunkie\Url\UrlShortenerProvider::class,

Also you can register the facade in aliases if you like.

  • 'Shortener' => LaraJunkie\Url\Shortener::class,

Configuration

Laravel Junkies UX9-URL-Shortener requires a configuration file.

To get started, you have to publish it:

$ php artisan vendor:publish --tag=lj-shortener

This will create a config/lj-shortener.php file in your config directory. Here you have to add your UX9 API Token.

Usage

$url = Shortener::short('http://example.com');

License

Laravel Junkies UX9-URL-Shortener is licensed under The MIT License (MIT).