Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 

README.markdown

Yourls

YOURLS is an open-source, PHP url-shortening service.

Installation

gem install yourls

Usage

Create a Yourls client using your hostname and api key as follows:

yourls = Yourls.new(your_hosted_yourls_address, your_hosted_yourls_api_key)

You can then interact with the client to shorten or expand urls or to get statistics about your service:

yourls.shorten('http://www.google.com')
yourls.shorten('http://www.google.com', :keyword => 'goog') # Creates a custom keyword url
yourls.expand('goog')
yourls.stats

expand and shorten both will return a Yourls::Url object

url = yourls.shorten('http://www.google.com', :keyword => 'goog')
url.short_url #=> "http://your-service/goog"
url.long_url #=> "http://www.google.com"
url.keyword #=> "goog"

Copyright

Copyright (c) 2010 Three Stage Media, Inc. and licensed under the MIT License (see MIT-LICENSE for details).

About

An API wrapper for the Yourls open-source URL shortener

Resources

License

Releases

No releases published

Languages

You can’t perform that action at this time.