From 2d31062dbc47209aee1968e30cfe6b51328fa7d7 Mon Sep 17 00:00:00 2001 From: Franck Cuny Date: Tue, 3 Feb 2015 08:22:01 -0800 Subject: Update and rename readme. --- README.md | 3 +++ readme.md | 41 ----------------------------------------- 2 files changed, 3 insertions(+), 41 deletions(-) create mode 100644 README.md delete mode 100644 readme.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..10c302a --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Net::HTTP::API + +This module has been deprecated in favor of [Net::HTTP::SPORE](https://github.com/franckcuny/net-http-spore). diff --git a/readme.md b/readme.md deleted file mode 100644 index fe15887..0000000 --- a/readme.md +++ /dev/null @@ -1,41 +0,0 @@ -# Net::HTTP::API - -## SYNOPSIS - - package My::Net::API; - use Net::HTTP::API; - - # we declare the API meta: - # - api_base_url : url that will be our base - # - api_format : what's the format for this API - # - api_format_mode: how do we set the format - - net_api_declare twitter => ( - api_base_url => 'http://search.twitter.com/', - api_format => 'json', - api_format_mode => 'append', - ); - - # we declare one method now: - # - method : HTTP method - # - path : path for the request - # - params : list of params accepted for this request - # - required: list of required params - - net_api_method search => ( - method => 'GET', - path => '/search', - params => [qw/q lang local page/], - required => [qw/q/], - ); - - 1; - - my $api = My::Net::API->new(); - my $res = $api->search(q => 'Perl'); - -## head1 DESCRIPTION - -Net::HTTP::API is a module to help to easily create a client for a web API. - -**THIS MODULE IS IN ITS BETA QUALITY. THE API MAY CHANGE IN THE FUTURE** -- cgit 1.4.1