[libhttp-entity-parser-perl] 03/11: synopsis

[gregor herrmann]

This is an automated email from the git hooks/post-receive script.

gregoa pushed a commit to tag 0.01
in repository libhttp-entity-parser-perl.

commit f11daf574a3bc44ac62273fac849676e89d0ff54
Author: Masahiro Nagano <kazeburo at gmail.com>
Date:   Tue Feb 4 16:48:06 2014 +0900

    synopsis
---
 META.json                 | 23 ++++++++++++++++++++++-
 README.md                 | 19 +++++++++++++++++--
 cpanfile                  |  4 ++--
 lib/HTTP/Entity/Parser.pm | 18 ++++++++++++++++--
 4 files changed, 57 insertions(+), 7 deletions(-)

diff --git a/META.json b/META.json
index 06b5637..3eb9c9a 100644
--- a/META.json
+++ b/META.json
@@ -1,5 +1,5 @@
 {
-   "abstract" : "It's new $module",
+   "abstract" : "PSGI compliant HTTP Entity Parser",
    "author" : [
       "Masahiro Nagano <kazeburo at gmail.com>"
    ],
@@ -43,15 +43,36 @@
       },
       "runtime" : {
          "requires" : {
+            "Encode" : "0",
+            "File::Temp" : "0",
+            "HTTP::Message" : "6",
+            "HTTP::MultiPartParser" : "0",
+            "JSON" : "2",
+            "Module::load" : "0",
+            "Stream::Buffered" : "0",
             "perl" : "5.008005"
          }
       },
       "test" : {
          "requires" : {
+            "Cwd" : "0",
+            "File::Spec::Functions" : "0",
+            "Hash::MultiValue" : "0",
             "Test::More" : "0.98"
          }
       }
    },
    "release_status" : "unstable",
+   "resources" : {
+      "bugtracker" : {
+         "web" : "https://github.com/kazeburo/HTTP-Entity-Parser/issues"
+      },
+      "homepage" : "https://github.com/kazeburo/HTTP-Entity-Parser",
+      "repository" : {
+         "type" : "git",
+         "url" : "git://github.com/kazeburo/HTTP-Entity-Parser.git",
+         "web" : "https://github.com/kazeburo/HTTP-Entity-Parser"
+      }
+   },
    "version" : "0.01"
 }
diff --git a/README.md b/README.md
index 2124fa8..912fb88 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,27 @@
 # NAME
 
-HTTP::Entity::Parser - It's new $module
+HTTP::Entity::Parser - PSGI compliant HTTP Entity Parser
 
 # SYNOPSIS
 
     use HTTP::Entity::Parser;
+    
+
+    my $parser = HTTP::Entity::Parser->new;
+    $parser->register('application/x-www-form-urlencoded','HTTP::Entity::Parser::UrlEncoded');
+    $parser->register('multipart/form-data','HTTP::Entity::Parser::MultiPart');
+    $parser->register('application/json','HTTP::Entity::Parser::JSON');
+
+    sub app {
+        my $env = shift;
+        my ( $params, $uploads) = $parser->parse($env);
+    }
 
 # DESCRIPTION
 
-HTTP::Entity::Parser is ...
+HTTP::Entity::Parser is PSGI compliant HTTP Entity parser. It also have compatibility with [HTTP::Body](http://search.cpan.org/perldoc?HTTP::Body)
+HTTP::Entity::Parser reads HTTP entity from \`psgi.input\` and parse it.
+This module support application/x-www-form-urlencoded, multipart/form-data and application/json.
 
 # LICENSE
 
@@ -20,3 +33,5 @@ it under the same terms as Perl itself.
 # AUTHOR
 
 Masahiro Nagano <kazeburo at gmail.com>
+
+Tokuhiro Matsuno <tokuhirom at gmail.com>
diff --git a/cpanfile b/cpanfile
index 3170f51..c70cb51 100644
--- a/cpanfile
+++ b/cpanfile
@@ -1,7 +1,7 @@
 requires 'perl', '5.008001';
 requires 'Stream::Buffered';
-requires 'Module::load''
-requires 'JSON' => 2;
+requires 'Module::load';
+requires 'JSON' => '2';
 requires 'Encode';
 requires 'HTTP::MultiPartParser';
 requires 'HTTP::Message' => 6;
diff --git a/lib/HTTP/Entity/Parser.pm b/lib/HTTP/Entity/Parser.pm
index 42f9b92..befa094 100644
--- a/lib/HTTP/Entity/Parser.pm
+++ b/lib/HTTP/Entity/Parser.pm
@@ -114,15 +114,27 @@ __END__
 
 =head1 NAME
 
-HTTP::Entity::Parser - It's new $module
+HTTP::Entity::Parser - PSGI compliant HTTP Entity Parser
 
 =head1 SYNOPSIS
 
     use HTTP::Entity::Parser;
+    
+    my $parser = HTTP::Entity::Parser->new;
+    $parser->register('application/x-www-form-urlencoded','HTTP::Entity::Parser::UrlEncoded');
+    $parser->register('multipart/form-data','HTTP::Entity::Parser::MultiPart');
+    $parser->register('application/json','HTTP::Entity::Parser::JSON');
+
+    sub app {
+        my $env = shift;
+        my ( $params, $uploads) = $parser->parse($env);
+    }
 
 =head1 DESCRIPTION
 
-HTTP::Entity::Parser is ...
+HTTP::Entity::Parser is PSGI compliant HTTP Entity parser. It also have compatibility with L<HTTP::Body>
+HTTP::Entity::Parser reads HTTP entity from `psgi.input` and parse it.
+This module support application/x-www-form-urlencoded, multipart/form-data and application/json.
 
 =head1 LICENSE
 
@@ -135,5 +147,7 @@ it under the same terms as Perl itself.
 
 Masahiro Nagano E<lt>kazeburo at gmail.comE<gt>
 
+Tokuhiro Matsuno E<lt>tokuhirom at gmail.comE<gt>
+
 =cut
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libhttp-entity-parser-perl.git