convert readme from unmarked POD to markdown

This commit is contained in:
Matthew Connelly 2015-03-14 23:52:58 +00:00
parent a4f8e5b48e
commit 122cd1fee6
1 changed files with 13 additions and 10 deletions

View File

@ -1,11 +1,13 @@
[![Build Status](https://travis-ci.org/MaffC/POE-Component-DirWatch-WithCaller.svg?branch=master)](https://travis-ci.org/MaffC/POE-Component-DirWatch-WithCaller) [![Build Status](https://travis-ci.org/MaffC/POE-Component-DirWatch-WithCaller.svg?branch=master)](https://travis-ci.org/MaffC/POE-Component-DirWatch-WithCaller)
POE-Component-DirWatch-WithCaller POE-Component-DirWatch-WithCaller
=================================
This module extends POE::Component::DirWatch to make life easier for those who wish to dynamically create DirWatch sessions which share common callbacks and filters. Functionality has also been included to allow previously-seen files to be filtered, hopefully improving poll performance. This module extends POE::Component::DirWatch to make life easier for those who wish to dynamically create DirWatch sessions which share common callbacks and filters. Functionality has also been included to allow previously-seen files to be filtered, hopefully improving poll performance.
INSTALLATION INSTALLATION
------------
To install this module, run the following commands: To install this module, run the following commands:
@ -15,25 +17,26 @@ To install this module, run the following commands:
make install make install
SUPPORT AND DOCUMENTATION SUPPORT AND DOCUMENTATION
-------------------------
After installing, you can find documentation for this module with the After installing, you can find documentation for this module with the
perldoc command. perldoc command.
perldoc POE::Component::DirWatch::WithCaller perldoc POE::Component::DirWatch::WithCaller
You can also look for information at: You can also look for information at:
RT, CPAN's request tracker (report bugs here) RT, CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-DirWatch-WithCaller http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-DirWatch-WithCaller
AnnoCPAN, Annotated CPAN documentation AnnoCPAN, Annotated CPAN documentation
http://annocpan.org/dist/POE-Component-DirWatch-WithCaller http://annocpan.org/dist/POE-Component-DirWatch-WithCaller
CPAN Ratings CPAN Ratings
http://cpanratings.perl.org/d/POE-Component-DirWatch-WithCaller http://cpanratings.perl.org/d/POE-Component-DirWatch-WithCaller
Search CPAN Search CPAN
http://search.cpan.org/dist/POE-Component-DirWatch-WithCaller/ http://search.cpan.org/dist/POE-Component-DirWatch-WithCaller/
LICENSE AND COPYRIGHT LICENSE AND COPYRIGHT
@ -44,7 +47,7 @@ This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at: copy of the full license at:
L<http://www.perlfoundation.org/artistic_license_2_0> http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or Versions is governed by this Artistic License. By using, modifying or