Permalink
Browse files

update README to reflect recent POD changes

using pod2markdown for a more useful README on github
  • Loading branch information...
leejo committed Jun 2, 2014
1 parent dce5631 commit 772e9f79697a9e9c180ce095fd3203b56b2a8e58
Showing with 72 additions and 47 deletions.
  1. +3 −0 Changes
  2. +69 −47 README
View
@@ -1,5 +1,8 @@
Revision history for CGI::Alternatives
+Next Version
+ - Links to alternatives (thanks: craig.treptow@gmail.com)
+
0.02 May 28, 2014
- Correct this Changes file
View
116 README
@@ -1,47 +1,69 @@
-NAME
- CGI::Alternatives - documentation for alternative solutions to CGI.pm
-
-VERSION
- 0.01
-
-DESCRIPTION
- This module doesn't do anything, it exists solely to document
- alternatives to the CGI module. This documentation is a work in
- progress, an example script will be shown in raw CGI.pm and then the
- equivalent implementation for each alternative will be shown. Resources
- to further information and documentation will also be included.
-
-BUT WHY?
- CGI.pm hasn't been considered good practice for many years, and there
- have been alternatives available for web development in perl for a long
- time. Despite this there are still some perl developers that will
- recommend the use of CGI.pm for web development and prototyping. The two
- main arguments for the use of CGI.pm, often given by those developers,
- are no longer true:
-
- 1) "CGI.pm is a core module so you don't have install anything extra."
- This is now incorrect:
-
- http://perl5.git.perl.org/perl.git/commitdiff/e9fa5a80
-
- If you are doing any serious web development you are going to have to
- use external dependencies, DBI is not in the core for example.
-
- 2) "CGI.pm scripts are shorter and simpler than alternative
- implementations." Again, not true and the following examples will show
- that.
-
-PSGI
-Plack
-Mojolicious
-Dancer
-Catalyst
-Others
-Dependency Handling
-AUTHOR INFORMATION
- Lee Johnson - `leejo@cpan.org'
-
- This library is free software; you can redistribute it and/or modify it
- under the same terms as Perl itself.
-
-SEE ALSO
+# NAME
+
+CGI::Alternatives - Documentation for alternative solutions to CGI.pm
+
+# VERSION
+
+0.03
+
+# DESCRIPTION
+
+This module doesn't do anything, it exists solely to document alternatives
+to the [CGI](https://metacpan.org/pod/CGI) module. This documentation is a work in progress, an example
+script will be shown in raw CGI.pm and then the equivalent implementation
+for each alternative will be shown. Resources to further information and
+documentation will also be included.
+
+# BUT WHY?
+
+CGI.pm hasn't been considered good practice for many years, and there have
+been alternatives available for web development in perl for a long time.
+Despite this there are still some perl developers that will recommend the
+use of CGI.pm for web development and prototyping. The two main arguments
+for the use of CGI.pm, often given by those developers, are no longer true:
+
+1) "CGI.pm is a core module so you don't have install anything extra." This
+is now incorrect:
+
+ http://perl5.git.perl.org/perl.git/commitdiff/e9fa5a80
+
+If you are doing any serious web development you are going to have to use
+external dependencies, DBI is not in the core for example.
+
+2) "CGI.pm scripts are shorter and simpler than alternative implementations."
+Again, not true and the following examples will show that.
+
+# PSGI
+
+[http://metacpan.org/pod/PSGI](http://metacpan.org/pod/PSGI)
+
+# Plack
+
+[http://metacpan.org/pod/Plack](http://metacpan.org/pod/Plack)
+
+# Mojolicious
+
+[http://metacpan.org/pod/Mojolicious](http://metacpan.org/pod/Mojolicious)
+
+# Dancer
+
+[http://metacpan.org/pod/Dancer](http://metacpan.org/pod/Dancer)
+
+# Catalyst
+
+[http://metacpan.org/pod/Catalyst](http://metacpan.org/pod/Catalyst)
+
+# Others
+
+[https://metacpan.org/search?q=web+frameworks](https://metacpan.org/search?q=web+frameworks)
+
+# Dependency Handling
+
+# AUTHOR INFORMATION
+
+Lee Johnson - `leejo@cpan.org`
+
+This library is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+# SEE ALSO

0 comments on commit 772e9f7

Please sign in to comment.