Skip to content

Commit

Permalink
Add readme from dzil build
Browse files Browse the repository at this point in the history
  • Loading branch information
LoonyPandora committed Nov 22, 2011
1 parent bd7c85d commit 313931a
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.markdown
@@ -0,0 +1,39 @@
# NAME

WWW::Shorten::GitHub - Shorten GitHub URLs using GitHub's URL shortener - git.io

# SYNOPSIS

This module provide a perl interface to GitHub's URL shortening service, git.io.

It allows you to shorten any GitHub URL, and also retrieve the original URL from
a pre-shortened URL

# USAGE

use WWW::Shorten 'GitHub';

my $long_url = 'https://github.com/LoonyPandora/WWW-Shorten-GitHub';

my $short_url = makeashorterlink($long_url);

# CAVEATS

Git.io only shortens URLs on github.com and its subdomains.

It is not a general purpose URL shortener.

# SEE ALSO

[WWW::Shorten](http://search.cpan.org/perldoc?WWW::Shorten), [http://git.io/help](http://git.io/help)

# AUTHOR

James Aitken <jaitken@cpan.org>

# COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by James Aitken.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

0 comments on commit 313931a

Please sign in to comment.