laravel-junkies / url-shortener
The official UX9 URL Shortener API for Laravel Users.
Installs: 1 131
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Requires
This package is auto-updated.
Last update: 2024-10-24 09:27:04 UTC
README
The official UX9 URL Shortener API for Laravel Users. NOTE: a UX9 API Key is required.
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).