Skip to content

Commit

Permalink
Regenerate README (using pod2readme)
Browse files Browse the repository at this point in the history
  • Loading branch information
bigpresh committed Sep 7, 2012
1 parent c7fbd9d commit c589dd7
Showing 1 changed file with 47 additions and 38 deletions.
85 changes: 47 additions & 38 deletions README
@@ -1,39 +1,48 @@
Finance::PremiumBonds README
===========================
NAME
Finance::PremiumBonds - Perl extension to check Premium Bond holder's
numbers

SYNOPSIS
use Finance::PremiumBonds;

if (defined(my $won = Finance::PremiumBonds::has_won($holder_number)))
{
print "Looks like you " . ($won)? 'may have won' : 'have not won';
} else {
warn "An error occurred.";
}

DESCRIPTION
Quick way to look up a Premium Bond holder's number on the National
Savings and Investments website to determine whether the holder has won
any prizes recently.

Currently I don't have a list of possible responses to look for (and
they could change at any time anyway) so the module will return true if
it receives a non-error response which doesn't include the recognised
negative response text. If it ever reports incorrect results to you,
please do let me know so I can update it.

FUNCTIONS
has_won($holder_number)
Checks whether $holder_number has won any prizes recently. Returns 1
if it looks like you've won, 0 if you haven't, or undef if it failed
to check.

AUTHOR
David Precious, <davidp@preshweb.co.uk>

COPYRIGHT AND LICENSE
Copyright (C) 2008-2012 by David Precious

This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself, either Perl version 5.8.7 or, at
your option, any later version of Perl 5 you may have available.

LIMITATIONS
Currently, the module detects lack of a recognised "losing" response
rather than the presence of a winning response; without a holder's
number which has won something, I can't see what the winning responses
look like. Maybe my meagre Premium Bonds investment will win something
one day, then I can update this module :)

A very simple module to look up a Premium Bond holder's number on the
National Savings and Investments website (www.nsandi.com) and determine
whether the holder's number has won a prize lately.

Currently I don't have a list of possible responses to look for (and they
could change at any time anyway) so the module will return true if it
receives a non-error response which doesn't include the recognised negative
response text. If it ever reports incorrect results to you, please do
let me know so I can update it.

INSTALLATION

To install this module type the following:

perl Makefile.PL
make
make test
make install

DEPENDENCIES

This module requires these other modules and libraries:

LWP


COPYRIGHT AND LICENCE

Copyright (C) 2008-2009 by David Precious

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.7 or,
at your option, any later version of Perl 5 you may have available.


$Id$

0 comments on commit c589dd7

Please sign in to comment.