Permalink
Browse files

Add a description.

  • Loading branch information...
1 parent 8ed8a25 commit 4ec092a440af240ffc2c5b324f372db34c6b5487 @markstos committed Nov 25, 2010
Showing with 9 additions and 0 deletions.
  1. +9 −0 lib/URI/Escape/XS.pm
View
@@ -122,6 +122,15 @@ $Id: XS.pm,v 0.8 2010/07/16 07:51:37 dankogai Exp $
=cut
+=head1 DESCRIPTION
+
+URI::Escape::XS is a drop-in replacement for URI::Escape for common cases which
+offers much faster performance by using compiled XS code.
+
+This module requires Perl 5.8.1 compared to 5.6.1 for URI::Escape.
+The uri_escape_utf8 function from URI::Escape is not present here, as
+our uri_escape() method handles UTF-8 characters automatically.
+
=head1 SYNOPSIS
# use it instead of URI::Escape

0 comments on commit 4ec092a

Please sign in to comment.