package Readonly::Values::Boolean;

use strict;
use warnings;

use Readonly::Enum;
use Readonly;
use Exporter qw(import);

=head1 NAME

Readonly::Values::Boolean - Boolean Constants

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.01';

=head1 SYNOPSIS

    use Readonly::Values::Boolean;

    my $value = $Readonly::Values::Boolean::booleans{'false'};

=cut

Readonly::Enum our ($FALSE, $TRUE) => 0;

Readonly::Hash our %booleans => (
	'off' => $FALSE,
	'false' => $FALSE,
	'FALSE' => $FALSE,
	'no' => $FALSE,
	'0' => $FALSE,
	'on' => $TRUE,
	'true' => $TRUE,
	'TRUE' => $TRUE,
	'yes' => $TRUE,
	'1' => $TRUE,
);

our @EXPORT = qw(
	$FALSE $TRUE
	%booleans
);

=head1 AUTHOR

Nigel Horne, C<< <njh at nigelhorne.com> >>

=head1 BUGS

=head1 SEE ALSO

=head1 SUPPORT

This module is provided as-is without any warranty.

Please report any bugs or feature requests to C<bug-readonly-values-booleans at rt.cpan.org>,
or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Readonly-Values-Boolean>.
I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc Readonly::Values::Boolean

You can also look for information at:

=over 4

=item * MetaCPAN

L<https://metacpan.org/dist/Readonly-Values-Boolean>

=item * RT: CPAN's request tracker

L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Readonly-Values-Boolean>

=item * CPAN Testers' Matrix

L<http://matrix.cpantesters.org/?dist=Readonly-Values-Boolean>

=item * CPAN Testers Dependencies

L<http://deps.cpantesters.org/?module=Readonly::Values::Boolean>

=back

=head1 LICENSE AND COPYRIGHT

Copyright 2027 Nigel Horne.

Usage is subject to licence terms.

The licence terms of this software are as follows:

=over 4

=item * Personal single user, single computer use: GPL2

=item * All other users (including Commercial, Charity, Educational, Government)
  must apply in writing for a licence for use from Nigel Horne at the
  above e-mail.

=back

=cut

1;
