Merge branch 'feature/markdown-readme' into develop

Makefile.PL

@@ -11,5 +11,5 @@ author_tests 'xt';
 test_requires 'Test::More';
 auto_set_repository;
 auto_include;
-readme_from 'lib/Amon2/Plugin/Web/FormValidator/Simple.pm';
+readme_markdown_from 'lib/Amon2/Plugin/Web/FormValidator/Simple.pm' => 'clean';
 WriteAll;

README.mkdn

@@ -0,0 +1,100 @@
+# NAME
+
+Amon2::Plugin::Web::FormValidator::Simple - Amon2 plugin
+
+# SYNOPSIS
+
+    # MyApp.pm
+
+    __PACKAGE__->load_plugins('Web::FormValidator::Simple');
+
+    # MyApp/Web/Dispatcher.pm
+
+    get '/user/{team}/{name}/' => sub {
+        my ($c) = @_;
+
+        # do validation
+        $c->form(
+            team => [qw!NOT_BLANK!, [qw!LENGTH 1 10!]],
+            name => [qw!NOT_BLANK!, [qw!LENGTH 1 10!]],
+        );
+
+        # if detect errors, return with a error page.
+        if ($c->form->has_error) {
+            return $c->render('error.tt');
+        }
+
+        ...
+    };
+
+    # same as C::P::FV::S, you can use messages/messages.yml
+
+    # development.pl
+    ...
+
+    +{
+        ...
+
+        validator => +{
+            message_format => '<p>%s</p>',
+            message_decode_from => 'UTF-8',
+            # messages => 'messages.yml',
+            messages => +{
+                account => +{
+                    team => +{
+                        NOT_BLANK => 'TEAM cannot be blank!',
+                        LENGTH => 'TEAM length must be [1, 10]',
+                    },
+                    name => +{
+                        NOT_BLANK => 'NAME cannnot be blank!',
+                        LENGTH => 'NAME length must be [1, 10]',
+                    },
+                },
+            },
+        },
+    };
+
+    # messages.yml
+
+    account:
+        team:
+            NOT_BLANK: TEAM cannot be blank!
+            LENGTH: TEAM length must be [1, 10]
+        name:
+            NOT_BLANK: NAME cannot be blank!
+            LENGTH: NAME length must be [1, 10]
+
+# DESCRIPTION
+
+Amon2::Plugin::Web::FormValidator::Simple is a port of
+[Catalyst::Plugin::FormValidator::Simple](http://search.cpan.org/perldoc?Catalyst::Plugin::FormValidator::Simple).
+This module has the same methods and options, so see her documents.
+
+# METHODS
+
+- `$c->init()`
+
+initial setup.
+
+- `$c->form()`
+
+validate form/query parameters.
+
+- `$c->set_invalid_form()`
+
+set error from manual validation.
+
+# AUTHOR
+
+JINNOUCHI Yasushi <delphinus@remora.cx>
+
+# SEE ALSO
+
+[Amon2::Web](http://search.cpan.org/perldoc?Amon2::Web)
+[FormValidator::Simple](http://search.cpan.org/perldoc?FormValidator::Simple)
+[Catalyst::Plugin::FormValidator::Simple](http://search.cpan.org/perldoc?Catalyst::Plugin::FormValidator::Simple)
+
+# LICENSE
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.

lib/Amon2/Plugin/Web/FormValidator/Simple.pm

@@ -67,7 +67,7 @@ Amon2::Plugin::Web::FormValidator::Simple - Amon2 plugin
     get '/user/{team}/{name}/' => sub {
         my ($c) = @_;
 
-        # do validate
+        # do validation
         $c->form(
             team => [qw!NOT_BLANK!, [qw!LENGTH 1 10!]],
             name => [qw!NOT_BLANK!, [qw!LENGTH 1 10!]],
@@ -128,15 +128,15 @@ This module has the same methods and options, so see her documents.
 
 =over 4
 
-=item $c->init()
+=item C<< $c->init() >>
 
 initial setup.
 
-=item $c->form()
+=item C<< $c->form() >>
 
 validate form/query parameters.
 
-=item $c->set_invalid_form()
+=item C<< $c->set_invalid_form() >>
 
 set error from manual validation.