   _____         _           _____                    
  |_   _|____  _| |_   _ _  |  ___|   _ _________   _ 
    | |/ _ \ \/ / __| (_|_) | |_ | | | |_  /_  / | | |
    | |  __/>  <| |_   _ _  |  _|| |_| |/ / / /| |_| |
    |_|\___/_/\_\\__| (_|_) |_|   \__,_/___/___|\__, |
                                                |___/ 


This is the README for Text::Fuzzy version 0.16_01.

Text::Fuzzy is a "module" for the Perl computer programming language, a library
of computer code to install on a computer.  This document contains four
sections:

1. About - what the module does

2. Documentation - how to learn more about the module

3. Installation - how to install this module on a computer

4. Help - what to do if you get stuck

-----------------------------------------------------------------------------

1. ABOUT

Text::Fuzzy - partial or fuzzy string matching using edit distances

This module calculates edit distances between words, and searches
arrays and files to find the nearest entry by edit distance. It
handles both byte strings and character strings (strings containing
Unicode), treating each Unicode character as a single entity.

    
    use Text::Fuzzy;
    use utf8;
    my $tf = Text::Fuzzy->new ('あいうえお☺');
    print $tf->distance ('うえお☺'), "\n";
    # prints "2".
    


The default is the Levenshtein edit distance, which applies an equal
weight of one to additions ("cat" -> "cart"), substitutions ("cat"
-> "cut"), and deletions ("carp" -> "cap"). The Damerau-Levenshtein
edit distance, which allows transpositions ("salt" -> "slat") may
also be selected.

-----------------------------------------------------------------------------

2. DOCUMENTATION

You can read the documentation for the module online at the following websites:

    * http://search.cpan.org/perldoc?Text::Fuzzy
    * http://metacpan.org/release/Text-Fuzzy

(These links go to the latest version of the module.)

After installing the module, you can read the documentation on your computer
using

    perldoc Text::Fuzzy

-----------------------------------------------------------------------------

3. INSTALLATION

This module requires Perl version 5.8.1 or later.

To install the module from CPAN, use

    cpan Text::Fuzzy

If you have the App::cpanminus installer, you may prefer

    cpanm Text::Fuzzy

To install the module from the source file, Text-Fuzzy-0.16_01.tar.gz, follow
this sequence of commands:

    tar xfz Text-Fuzzy-0.16_01.tar.gz
    cd Text-Fuzzy-0.16_01
    perl Makefile.PL
    make
    make install

If you want to test the module before installing it, use "make test" after
"make" and before "make install".

-----------------------------------------------------------------------------

4. HELP

To get help with the module, you can email the author, Ben Bullock, at
<bkb@cpan.org>. If you think there is a problem in the module, you can report a
bug at 

<https://github.com/benkasminbullock/Text-Fuzzy/issues>,

or if you want to alter the source code of Text::Fuzzy, try the public
repository on github at 

<https://github.com/benkasminbullock/Text-Fuzzy>. 

-----------------------------------------------------------------------------

This README was written on Tue Jan 27 12:54:34 2015.

-----------------------------------------------------------------------------
