Imported upstream version 0.12

[liburi-template-perl.git] / README

diff --git a/README b/README
index eb4da93..c632c13 100644 (file)
--- a/README
+++ b/README
@@ -13,22 +13,13 @@ SYNOPSIS
 DESCRIPTION
     This is an initial attempt to provide a wrapper around URI templates as
     described at
-    http://www.ietf.org/internet-drafts/draft-gregorio-uritemplate-00.txt
+    http://www.ietf.org/internet-drafts/draft-gregorio-uritemplate-01.txt
 
 INSTALLATION
-    To install this module via Module::Build:
-
-            perl Build.PL
-            ./Build         # or `perl Build`
-            ./Build test    # or `perl Build test`
-            ./Build install # or `perl Build install`
-
-    To install this module via ExtUtils::MakeMaker:
-
-            perl Makefile.PL
-            make
-            make test
-            make install
+        perl Makefile.PL
+        make
+        make test
+        make install
 
 METHODS
   new( $template )
@@ -40,26 +31,31 @@ METHODS
     stringified.
 
   variables( )
-    Returns an array of variable names found in the template. NB: they are
-    returned in random order.
+    Returns an array of unique variable names found in the template. NB:
+    they are returned in random order.
+
+  all_variables( )
+    Returns an array of variable names found as they appear in template --
+    in order, duplicates included.
 
-  process( %vars )
-    Given a list of key-value pairs, it will URI escape the values and
-    substitute them in to the template. Returns a URI object.
+  process( %vars|\@values )
+    Given a list of key-value pairs or an array ref of values (for
+    positional substitution), it will URI escape the values and substitute
+    them in to the template. Returns a URI object.
 
-  process_to_string( %vars )
-    Processes key-values pairs like the "process" method, but doesn't
-    inflate the result to a URI object.
+  process_to_string( %vars|\@values )
+    Processes input like the "process" method, but doesn't inflate the
+    result to a URI object.
 
   deparse( $uri )
     Does some rudimentary deparsing of a uri based on the current template.
     Returns a hash with the extracted values.
 
 AUTHOR
-    * Brian Cassidy <bricas@cpan.org>
+    Brian Cassidy <bricas@cpan.org>
 
 COPYRIGHT AND LICENSE
-    Copyright 2007 by Brian Cassidy
+    Copyright 2008 by Brian Cassidy
 
     This library is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.