diff options
| -rw-r--r-- | Build.PL | 2 | ||||
| -rw-r--r-- | MANIFEST | 2 | ||||
| -rw-r--r-- | README | 48 | ||||
| -rw-r--r-- | README.md | 61 | ||||
| -rw-r--r-- | lib/TUWF.pod | 2 |
5 files changed, 64 insertions, 51 deletions
@@ -20,7 +20,7 @@ Module::Build->new( }, meta_merge => { resources => { - repository => 'https://g.blicky.net/tuwf.git/', + repository => 'https://code.blicky.net/yorhel/tuwf', homepage => 'https://dev.yorhel.nl/tuwf' }, }, @@ -23,5 +23,5 @@ Makefile.PL MANIFEST This list of files META.json META.yml -README +README.md t/kv_validate.t @@ -1,48 +0,0 @@ -TUWF - The Ultimate Website Framework -------------------------------------- - -This package provides the following set of modules: - - TUWF - TUWF::DB - TUWF::Misc - TUWF::Request - TUWF::Response - TUWF::XML - -Documentation for each of these modules is provided in a .pod file along -their .pm implementations. Check out the documentation of the main TUWF -module for a general introduction. - - -Optional dependencies: - (Perl core modules not listed) - - DBI for SQL functionality (TUWF::DB) - FCGI to run in a FastCGI environment - HTTP::Server::Simple to run the standalone HTTP server - JSON::XS for JSON requests & responses - PerlIO::gzip for output compression - - -Installing: - - If you have obtained a TUWF package and do not have Module::Build installed: - - perl Makefile.PL - make - make install - - Otherwise: - - perl Build.PL - ./Build - ./Build install - - -Contact - - Homepage: https://dev.yorhel.nl/tuwf - Git: https://g.blicky.net/tuwf.git/ - Email: projects@yorhel.nl - diff --git a/README.md b/README.md new file mode 100644 index 0000000..fdd3386 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# TUWF - The Ultimate Website Framework + +This package provides the following set of modules: + +- [TUWF](https://dev.yorhel.nl/tuwf/man) +- [TUWF::DB](https://dev.yorhel.nl/tuwf/man/db) +- [TUWF::Misc](https://dev.yorhel.nl/tuwf/man/misc) +- [TUWF::Request](https://dev.yorhel.nl/tuwf/man/request) +- [TUWF::Response](https://dev.yorhel.nl/tuwf/man/response) +- [TUWF::Validate](https://dev.yorhel.nl/tuwf/man/validate) +- [TUWF::XML](https://dev.yorhel.nl/tuwf/man/xml) + +Documentation for each of these modules is provided in a .pod file along +their .pm implementations. Check out the documentation of the main TUWF +module for a general introduction. + +More information is available on the homepage at +[https://dev.yorhel.nl/tuwf](https://dev.yorhel.nl/tuwf). + + +## Optional dependencies + +(Perl core modules not listed) + +- [DBI](https://metacpan.org/release/DBI) - for SQL functionality (TUWF::DB) +- [FCGI](https://metacpan.org/release/FCGI) - to run in a FastCGI environment +- [HTTP::Server::Simple](https://metacpan.org/release/HTTP-Server-Simple) - to run the standalone HTTP server +- [JSON::XS](https://metacpan.org/release/JSON-XS) - for JSON requests & responses +- [PerlIO::gzip](https://metacpan.org/release/PerlIO-gzip) - for output compression + + +## Installing + +From CPAN: + +``` + cpan TUWF +``` + +From the repo (using cpanminus): + +``` + cpanm . +``` + +Manually: + +``` + perl Build.PL + ./Build + ./Build install +``` + + +## Contact + +Homepage: [https://dev.yorhel.nl/tuwf](https://dev.yorhel.nl/tuwf) + +Git: [https://code.blicky.net/yorhel/tuwf](https://code.blicky.net/yorhel/tuwf) + +Email: projects@yorhel.nl diff --git a/lib/TUWF.pod b/lib/TUWF.pod index ff66282..a769423 100644 --- a/lib/TUWF.pod +++ b/lib/TUWF.pod @@ -843,7 +843,7 @@ The homepage of TUWF can be found at L<https://dev.yorhel.nl/tuwf|https://dev.yorhel.nl/tuwf>. TUWF is available on a git repository at -L<https://g.blicky.net/tuwf.git/|https://g.blicky.net/tuwf.git/>. +L<https://code.blicky.net/yorhel/tuwf|https://code.blicky.net/yorhel/tuwf>. =head1 COPYRIGHT |