From dd8998e56766432799195cad7902115a4dd94b81 Mon Sep 17 00:00:00 2001 From: Nigel Horne Date: Mon, 14 Nov 2016 11:42:44 -0500 Subject: [PATCH] Added README.md --- README.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++ t/coverage.t | 18 +++++++++++ 2 files changed, 103 insertions(+) create mode 100644 README.md create mode 100644 t/coverage.t diff --git a/README.md b/README.md new file mode 100644 index 0000000..16a24e8 --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# Data::Fetch + +Give advance warning that you'll be needing a value + +# VERSION + +Version 0.01 + +# SYNOPSIS + +Sometimes we know in advance that we'll be needing a value which is going to take a long time to compute or determine. +This module fetches the value in the background so that you don't need to wait so long when you need the value + + use Data::Fetch; + my $fetcher = Data::Fetch->new(); + my $object = CalculatePi->new(places => 1000000); + $fetcher->prime(object => $object, message => get); + # Do other things + print $fetcher->get(object => $object, message => get), "\n"; + +# SUBROUTINES/METHODS + +## new + +Creates a Data::Fetch object. Takes no argument. + +## prime + +Say what is is you'll be needing later. Takes two mandatory parameters: + +object - the object you'll be sending the message to +message - the message you'll be sending + +## prime + +Retrieve get a value you've primed. Takes two mandatory parameters: + +object - the object you'll be sending the message to +message - the message you'll be sending + +# AUTHOR + +Nigel Horne, `` + +# BUGS + +Can't give arguments to the message. + +Please report any bugs or feature requests to `bug-data-fetch at rt.cpan.org`, +or through the web interface at +[http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Fetch](http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Fetch). +I will be notified, and then you'll +automatically be notified of progress on your bug as I make changes. + +# SEE ALSO + +# SUPPORT + +You can find documentation for this module with the perldoc command. + + perldoc Data::Fetch + +You can also look for information at: + +- RT: CPAN's request tracker + + [http://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Fetch](http://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Fetch) + +- AnnoCPAN: Annotated CPAN documentation + + [http://annocpan.org/dist/Data-Fetch](http://annocpan.org/dist/Data-Fetch) + +- CPAN Ratings + + [http://cpanratings.perl.org/d/Data-Fetch](http://cpanratings.perl.org/d/Data-Fetch) + +- Search CPAN + + [http://search.cpan.org/dist/Data-Fetch/](http://search.cpan.org/dist/Data-Fetch/) + +# LICENSE AND COPYRIGHT + +Copyright 2016 Nigel Horne. + +This program is released under the following licence: GPL diff --git a/t/coverage.t b/t/coverage.t new file mode 100644 index 0000000..813e3fc --- /dev/null +++ b/t/coverage.t @@ -0,0 +1,18 @@ +use strict; +use warnings; +use Test::Most; + +# Ensure a recent version of Test::Pod::Coverage +my $min_tpc = 1.08; +eval "use Test::Pod::Coverage $min_tpc"; +plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage" + if $@; + +# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version, +# but older versions don't recognize some common documentation styles +my $min_pc = 0.18; +eval "use Pod::Coverage $min_pc"; +plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage" + if $@; + +all_pod_coverage_ok();