view release on metacpan or  search on metacpan

lib/Acme/CPANModules/Soundex.pm  view on Meta::CPAN

package Acme::CPANModules::Soundex;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-11-20'; # DATE
our $DIST = 'Acme-CPANModules-Soundex'; # DIST
our $VERSION = '0.001'; # VERSION

our $LIST = {
    summary => "List of modules that implement the soundex algorithm",
    description => <<'MARKDOWN',


MARKDOWN
    entries => [
        {
            module => 'Text::Soundex',
        },
        {
            module => 'Text::Phonetic::Soundex',
            description => <<'MARKDOWN',

Part of a family of modules that implement phonetic algorithms.

MARKDOWN
        },
    ],
};

1;
# ABSTRACT: List of modules that implement the soundex algorithm

__END__

=pod

=encoding UTF-8

=head1 NAME

Acme::CPANModules::Soundex - List of modules that implement the soundex algorithm

=head1 VERSION

This document describes version 0.001 of Acme::CPANModules::Soundex (from Perl distribution Acme-CPANModules-Soundex), released on 2024-11-20.

=head1 ACME::CPANMODULES ENTRIES

=over

=item L<Text::Soundex>

Author: L<RJBS|https://metacpan.org/author/RJBS>

=item L<Text::Phonetic::Soundex>

Author: L<MAROS|https://metacpan.org/author/MAROS>

Part of a family of modules that implement phonetic algorithms.


=back

=head1 FAQ

=head2 What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module
names that share a common characteristics. It is a way to categorize modules and
document CPAN. See L<Acme::CPANModules> for more details.

=head2 What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can
install all the listed modules (entries) using L<cpanm-cpanmodules> script (from
L<App::cpanm::cpanmodules> distribution):

 % cpanm-cpanmodules -n Soundex

Alternatively you can use the L<cpanmodules> CLI (from L<App::cpanmodules>
distribution):

    % cpanmodules ls-entries Soundex | cpanm -n

or L<Acme::CM::Get>:

    % perl -MAcme::CM::Get=Soundex -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

    % perl -MAcme::CPANModules::Soundex -E'say $_->{module} for @{ $Acme::CPANModules::Soundex::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps L<lcpan> produce a more meaningful
result for C<lcpan related-mods> command when it comes to finding related
modules for the modules listed in this Acme::CPANModules module.
See L<App::lcpan::Cmd::related_mods> for more details on how "related modules"
are found.