add Vcs- fields

[libwww-opensearch-perl.git] / README

diff --git a/README b/README
index c77f030..ad58d7d 100644 (file)
--- a/README
+++ b/README
@@ -1,69 +1,73 @@
-NAME\r
-    WWW::OpenSearch - Search A9 OpenSearch compatible engines\r
-\r
-SYNOPSIS\r
-        use WWW::OpenSearch;\r
-    \r
-        my $url = "http://bulkfeeds.net/opensearch.xml";\r
-        my $engine = WWW::OpenSearch->new($url);\r
-    \r
-        my $name = $engine->description->ShortName;\r
-        my $tags = $engine->description->Tags;\r
-    \r
-        # Perform search for "iPod"\r
-        my $response = $engine->search("iPod");\r
-        for my $item (@{$response->feed->items}) {\r
-            print $item->{description};\r
-        }\r
-    \r
-        # Retrieve the next page of results\r
-        my $next_page = $response->next_page;\r
-        for my $item (@{$next_page->feed->items}) {\r
-            print $item->{description};\r
-        }\r
-\r
-DESCRIPTION\r
-    WWW::OpenSearch is a module to search A9's OpenSearch compatible search\r
-    engines. See http://opensearch.a9.com/ for details.\r
-\r
-CONSTRUCTOR\r
-  new( $url )\r
-    Constructs a new instance of WWW::OpenSearch using the given URL as the\r
-    location of the engine's OpenSearch Description document (retrievable\r
-    via the description_url accessor).\r
-\r
-METHODS\r
-  fetch_description( [ $url ] )\r
-    Fetches the OpenSearch Descsription found either at the given URL or at\r
-    the URL specified by the description_url accessor. Fetched description\r
-    may be accessed via the description accessor.\r
-\r
-  search( $query [, \%params] )\r
-    Searches the engine for the given query using the given search\r
-    parameters. Valid search parameters include:\r
-\r
-    * startPage\r
-    * totalResults\r
-    * startIndex\r
-    * itemsPerPage\r
-\r
-    See http://opensearch.a9.com/spec/1.1/response/#elements for details.\r
-\r
-  do_search( $url [, $method] )\r
-    Performs a request for the given URL and returns a\r
-    WWW::OpenSearch::Response object. Method defaults to 'GET'.\r
-\r
-ACCESSORS\r
-  description_url( [$description_url] )\r
-  agent( [$agent] )\r
-  description( [$description] )\r
-AUTHOR\r
-    * Tatsuhiko Miyagawa <miyagawa@bulknews.net>\r
-    * Brian Cassidy <bricas@cpan.org>\r
-\r
-COPYRIGHT AND LICENSE\r
-    Copyright 2006 by Tatsuhiko Miyagawa and Brian Cassidy\r
-\r
-    This library is free software; you can redistribute it and/or modify it\r
-    under the same terms as Perl itself.\r
-\r
+NAME
+    WWW::OpenSearch - Search A9 OpenSearch compatible engines
+
+SYNOPSIS
+        use WWW::OpenSearch;
+    
+        my $url = "http://bulkfeeds.net/opensearch.xml";
+        my $engine = WWW::OpenSearch->new($url);
+    
+        my $name = $engine->description->ShortName;
+        my $tags = $engine->description->Tags;
+    
+        # Perform search for "iPod"
+        my $response = $engine->search("iPod");
+        for my $item (@{$response->feed->items}) {
+            print $item->{description};
+        }
+    
+        # Retrieve the next page of results
+        my $next_page = $response->next_page;
+        for my $item (@{$next_page->feed->items}) {
+            print $item->{description};
+        }
+
+DESCRIPTION
+    WWW::OpenSearch is a module to search A9's OpenSearch compatible search
+    engines. See http://opensearch.a9.com/ for details.
+
+CONSTRUCTOR
+  new( $url )
+    Constructs a new instance of WWW::OpenSearch using the given URL as the
+    location of the engine's OpenSearch Description document (retrievable
+    via the description_url accessor).
+
+METHODS
+  fetch_description( [ $url ] )
+    Fetches the OpenSearch Descsription found either at the given URL or at
+    the URL specified by the description_url accessor. Fetched description
+    may be accessed via the description accessor.
+
+  search( $query [, \%params] )
+    Searches the engine for the given query using the given search
+    parameters. Valid search parameters include:
+
+    *   startPage
+
+    *   totalResults
+
+    *   startIndex
+
+    *   itemsPerPage
+
+    See http://opensearch.a9.com/spec/1.1/response/#elements for details.
+
+  do_search( $url [, $method] )
+    Performs a request for the given URL and returns a
+    WWW::OpenSearch::Response object. Method defaults to 'GET'.
+
+ACCESSORS
+  description_url( [$description_url] )
+  agent( [$agent] )
+  description( [$description] )
+AUTHOR
+    Brian Cassidy <bricas@cpan.org>
+
+    Tatsuhiko Miyagawa <miyagawa@bulknews.net>
+
+COPYRIGHT AND LICENSE
+    Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy
+
+    This library is free software; you can redistribute it and/or modify it
+    under the same terms as Perl itself.
+