diff --git a/README b/README index e69de29..f7889a3 100644 --- a/README +++ b/README @@ -0,0 +1,20 @@ +This script will intercept all messages (quit, part, channel, and private) +searching for URLs. If the URL is a "short" URL (tinyurl, t.co, bit,ly, etc) +it will be expanded into the real URL. The expansion is done by the fine folks +at longurl.org. + +Configuration options for this script include: + expand_url_privmsgs - A boolean which toggles whether private + messages are searched or not. + expand_url_white - A string of whitespace delimited + channels in which expanded is to take place. + For example, '#news &twitter #shorturls' + If this variable is left undefined, all + channels are searched for shortened URLs. + +I'm not sure that expand_url_white is really needed. + +If you find any bugs, having any suggestions, or just want to chat, +hit me up! + +Have fun, and hope you like it.