Imported Upstream version 0.0602

[libwww-opensearch-perl.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..c77f030
--- /dev/null
+++ b/README
@@ -0,0 +1,69 @@
+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