Contents

= ShortURL 0.5.0

== Summary 
ShortURL is a very simple library to use URL shortening services such as
TinyURL or RubyURL.

== Installation
ShortURL is available as a gem, installation is just like any other gem:
<tt>$ gem install -r shorturl</tt>

You can also download the tar.bz2 archive at
http://rubyforge.org/frs/?group_id=732 if you do not want to use the gem.

== Usage: 
call-seq:
  require "shorturl"
  puts ShortURL.shorten("http://mypage.com")
  puts ShortURL.shorten("http://mypage.com", :tinyurl)

The second parameter represents the service you want to use.  These are:
- <tt>:rubyurl</tt>
- <tt>:tinyurl</tt>
- <tt>:snorl</tt>
- <tt>:snipurl</tt>
- <tt>:metamark</tt>
- <tt>:makeashorterlink</tt>
- <tt>:skinnylink</tt>
- <tt>:linktrim</tt>
- <tt>:shorterlink</tt>
- <tt>:minilink</tt>
- <tt>:lns</tt>
- <tt>:fyad</tt>

You can use <tt>ShortURL.valid_services</tt> to obtain a
list of the valid services (in case I forget to update the
documentation)

== Thanks
- Marcel Molina Jr., Devin Mullins for some ideas
- imperator from #ruby-lang (don't know your real name, sorry) for
  helping me with creating and uploading a RubyGem
- Daniel Dipaolo for telling me about ln-s.net and fyad.org
  
== Author
Vincent Foley

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
shorturl-0.5.0	README