X-Git-Url: http://erislabs.net/gitweb/?p=liburi-template-perl.git;a=blobdiff_plain;f=README;h=b8e622498b34c87d41469717b5ddbac37ab2cfc0;hp=75f354a5b62ddb7f5072dd73caa1ba1bac8bfe4e;hb=142608d2df1288332140ed21c03b383cd6eed66f;hpb=3f3d56e5fb9a55ee113ccf2bc03f3a453f80baa0

diff --git a/README b/README
index 75f354a..b8e6224 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 NAME
-    URI::Template - Object for handling URI templates
+    URI::Template - Object for handling URI templates (RFC 6570)
 
 SYNOPSIS
         use URI::Template;
@@ -7,58 +7,49 @@ SYNOPSIS
         my $uri      = $template->process( x => 'y' );
         # uri is a URI object with value 'http://example.com/y'
 
-        my %result = $template->deparse( $uri );
-        # %result is ( x => 'y' )
-
 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
+    This module provides a wrapper around URI templates as described in RFC
+    6570: <http://tools.ietf.org/html/rfc6570>.
 
 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 )
     Creates a new URI::Template instance with the template passed in as the
     first parameter.
 
-  as_string( )
-    Returns the original template string. Also used when the object is
-    stringified.
+  template
+    This method returns the original template string.
+
+  variables
+    Returns an array of unique variable names found in the template. NB:
+    they are returned in random order.
 
-  variables( )
-    Returns an array of variable names found in the template.
+  expansions
+    This method returns an list of expansions found in the template.
+    Currently, these are just coderefs. In the future, they will be more
+    interesting.
 
-  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 )
+    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 )
+    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.
+AUTHORS
+    *   Brian Cassidy <bricas@cpan.org>
 
-AUTHOR
-    * Brian Cassidy <bricas@cpan.org>
+    *   Ricardo SIGNES <rjbs@cpan.org>
 
 COPYRIGHT AND LICENSE
-    Copyright 2007 by Brian Cassidy
+    Copyright 2007-2013 by Brian Cassidy
 
     This library is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.