=head1 NAME

String::Locale::YAML - display text locally loading data from a YAML file.

=head1 VERSION

Version 0.03

=cut

=head1 SYNOPSIS

Quick summary of what the module does:

	use String::Locale {
		locale => 'en_GB',
	}, file => './path/to/file.yml';

	say locales->stranger;

	....

	use String::Locale::YAML;

	my $locales = String::Locale::YAML->new(
		{
			file => 'path/to/file.yml',
			locale => 'ja_JP',
		}
	);

	say $locales->stranger;

=head1 SUBROUTINES/METHODS

=head2 new

Instantiate a new String::Locale::YAML object.

	String::Locale::YAML->new

=head2 load_file

Load a yaml file into the objects locales hash. Accepts a single argument that should be a path to a file that contains valid YAML markup.

	$obj->load_file($file)

=head2 write_file

Write the current locales hash into a yaml file. Accepts a single argument that should be a path to where the YAML file will be writtern.

	$obj->write_file($file)

=head1 ACCESSORS

=head2 file

A path to a file that contains valid YAML markup.

	$obj->file;

	$obj->file($value);

=head1 AUTHOR

LNATION, C<< <email at lnation.org> >>

=head1 BUGS

Please report any bugs or feature requests to C<bug-string::locale::yaml at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=String-Locale-YAML>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

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

    perldoc String::Locale::YAML

You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=String-Locale-YAML>

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/String-Locale-YAML>

=item * CPAN Ratings

L<https://cpanratings.perl.org/d/String-Locale-YAML>

=item * Search CPAN

L<https://metacpan.org/release/String-Locale-YAML>

=back

=head1 ACKNOWLEDGEMENTS

=head1 LICENSE AND COPYRIGHT

This software is Copyright (c) 2020 by LNATION.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

=cut

 
