<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>File: README</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="fileHeader">
<h1>README</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Mon Mar 02 08:07:08 -0800 2009</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<h1><a href="../classes/ShortURL.html">ShortURL</a> 0.8.4</h1>
<h2>Summary</h2>
<p>
<a href="../classes/ShortURL.html">ShortURL</a> is a very simple library to
use URL shortening services such as RubyURL, urlTea, and TinyURL.
</p>
<h2>Installation</h2>
<p>
<a href="../classes/ShortURL.html">ShortURL</a> is available as a gem,
installation is just like any other gem: <tt>$ gem install shorturl</tt>
</p>
<p>
You can also download the tar.bz2 archive at <a
href="http://rubyforge.org/frs/?group_id=732">rubyforge.org/frs/?group_id=732</a>
if you do not want to use the gem.
</p>
<h2>Supported services</h2>
<p>
Here is the list of the services supported by <a
href="../classes/ShortURL.html">ShortURL</a>:
</p>
<ul>
<li><a href="http://rubyurl.com">rubyurl.com</a>
</li>
<li><a href="http://tinyurl.com">tinyurl.com</a>
</li>
<li><a href="http://shorl.com">shorl.com</a>
</li>
<li><a href="http://snipurl.com">snipurl.com</a>
</li>
<li><a href="http://metamark.net">metamark.net</a>
</li>
<li><a href="http://makeashorterlink.com">makeashorterlink.com</a>
</li>
<li><a href="http://skinnylink.com">skinnylink.com</a>
</li>
<li><a href="http://linktrim.com">linktrim.com</a>
</li>
<li><a href="http://shorterlink.com">shorterlink.com</a>
</li>
<li><a href="http://minilink.org">minilink.org</a>
</li>
<li><a href="http://ln-s.net">ln-s.net</a>
</li>
<li><a href="http://fyad.org">fyad.org</a>
</li>
<li><a href="http://d62.net">d62.net</a>
</li>
<li><a href="http://shiturl.com">shiturl.com</a>
</li>
<li><a href="http://littlink.com">littlink.com</a>
</li>
<li><a href="http://clipurl.com">clipurl.com</a>
</li>
<li><a href="http://shortify.com">shortify.com</a>
</li>
<li><a href="http://0rz.net">0rz.net</a>
</li>
<li><a href="http://moourl.com">moourl.com</a>
</li>
<li><a href="http://urltea.com">urltea.com</a>
</li>
</ul>
<h2>Usage:</h2>
<p>
call-seq:
</p>
<pre>
require "shorturl"
puts ShortURL.shorten("http://mypage.com")
puts ShortURL.shorten("http://mypage.com", :moourl)
</pre>
<p>
The second parameter represents the service you want to use. These are:
</p>
<ul>
<li><tt>:rubyurl</tt>
</li>
<li><tt>:tinyurl</tt>
</li>
<li><tt>:shorl</tt>
</li>
<li><tt>:snipurl</tt>
</li>
<li><tt>:metamark</tt>
</li>
<li><tt>:makeashorterlink</tt>
</li>
<li><tt>:skinnylink</tt>
</li>
<li><tt>:linktrim</tt>
</li>
<li><tt>:shorterlink</tt>
</li>
<li><tt>:minlink</tt>
</li>
<li><tt>:lns</tt>
</li>
<li><tt>:fyad</tt>
</li>
<li><tt>:d62</tt>
</li>
<li><tt>:shiturl</tt>
</li>
<li><tt>:littlink</tt>
</li>
<li><tt>:clipurl</tt>
</li>
<li><tt>:shortify</tt>
</li>
<li><tt>:orz</tt>
</li>
<li><tt>:moourl</tt>
</li>
<li><tt>:urltea</tt>
</li>
</ul>
<p>
You can use <tt><a
href="../classes/ShortURL.html#M000001">ShortURL.valid_services</a></tt> to
obtain a list of the valid services (in case I forget to update the
documentation)
</p>
<h2>Thanks</h2>
<ul>
<li>Marcel Molina Jr., Devin Mullins for some ideas
</li>
<li>imperator from ruby-lang (I don‘t know your real name, sorry) for
helping me with creating and uploading a RubyGem
</li>
<li>Daniel Dipaolo for telling me about ln-s.net and fyad.org
</li>
</ul>
<h2>Authors</h2>
<ul>
<li>Vincent Foley (original developer)
</li>
<li>Robby Russell <robbyrussell@gmail.com>
</li>
</ul>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>