From 4221ecd6c932617167b810c7ca0ec9655788ae2a Mon Sep 17 00:00:00 2001
From: Tom Feist <shabble@metavore.org>
Date: Fri, 8 Jul 2011 10:29:08 +0100
Subject: update install instructions to mention IrssiX modules, and generate a
 readme.

---
 longify/README.pod      | 77 +++++++++++++++++++++++++++++++++++++++++++++++++
 longify/longify-urls.pl | 12 +++++++-
 2 files changed, 88 insertions(+), 1 deletion(-)
 create mode 100644 longify/README.pod

(limited to 'longify')

diff --git a/longify/README.pod b/longify/README.pod
new file mode 100644
index 0000000..25a7f8e
--- /dev/null
+++ b/longify/README.pod
@@ -0,0 +1,77 @@
+=pod
+
+=head1 NAME
+
+longify-urls.pl
+
+=head1 DESCRIPTION
+
+Checks channel messages for 'shortened' links, and expands them to their
+final target address.
+
+=head1 INSTALLATION
+
+=over
+
+=item Download the modules from L<http://mauke.dyndns.org/stuff/irssi/lib/IrssiX/>
+and place them in a directory known to Perl (One of the default system locations
+for perl modules, or somewhere that is listed in the C<$PERL5LIB> environment variable).
+They should be placed in a subdirectory named C<IrssiX> in whichever module directory
+you choose.
+
+=item Copy this script into your F<~/.irssi/scripts/> directory and load with
+C</SCRIPT LOAD F<filename>>.
+
+=back
+
+=head1 USAGE
+
+Load it.
+
+B<Note:> The lookup to check if a link is shortened runs in the background, so it
+won't affect the running of Irssi, but the message containing the link is queued
+until either a response comes back, or the timeout (~2 seconds) is hit.
+
+=head1 AUTHORS
+
+Copyright E<copy> 2011 Tom Feist C<E<lt>shabble+irssi@metavore.orgE<gt>>
+
+=head1 LICENCE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+=head1 BUGS
+
+
+=head1 TODO
+
+=over
+
+=item * Not tested with simultaneous lookups
+
+=item * User-configurable timeout
+
+=item * some sort of list of shorteners? (saves having to look up every single url)
+
+=back
+
+
+
+=cut
+
diff --git a/longify/longify-urls.pl b/longify/longify-urls.pl
index 208e468..7d352dc 100644
--- a/longify/longify-urls.pl
+++ b/longify/longify-urls.pl
@@ -11,9 +11,19 @@ final target address.
 
 =head1 INSTALLATION
 
-Copy into your F<~/.irssi/scripts/> directory and load with
+=over
+
+=item Download the modules from L<http://mauke.dyndns.org/stuff/irssi/lib/IrssiX/>
+and place them in a directory known to Perl (One of the default system locations
+for perl modules, or somewhere that is listed in the C<$PERL5LIB> environment variable).
+They should be placed in a subdirectory named C<IrssiX> in whichever module directory
+you choose.
+
+=item Copy this script into your F<~/.irssi/scripts/> directory and load with
 C</SCRIPT LOAD F<filename>>.
 
+=back
+
 =head1 USAGE
 
 Load it.
-- 
cgit v1.2.3