Changeset 19 in mp3-find for trunk/README


Ignore:
Timestamp:
03/28/06 19:38:39 (19 years ago)
Author:
peter
Message:
  • added "status_callback" option to the constructor for MP3::Find::DB
  • default status callback just prints the status code and the file name to STDERR as before
  • using an empty status_callback in t/03-db.t (status_callback => sub {}) to keep the test output more legible
  • updated docs in Find.pm
  • mkreadme now prints a blank line between the file header and the DESCRIPION section
  • generated new README file
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README

    r1 r19  
    1 MP3::Find version 0.01 
     1MP3::Find version 0.04 
    22====================== 
     3 
    34DESCRIPTION 
    45    This module allows you to search for MP3 files by their ID3 tags. You 
     
    78    formatted string for each file using its ID3 tags, or the actual Perl 
    89    data structure representing the results. 
     10 
     11    There are currently two backends to this module: MP3::Find::Filesystem 
     12    and MP3::Find::DB. You choose which one you want by passing its name as 
     13    the argument to you "use" statement; MP3::Find will look for a 
     14    MP3::Find::$BACKEND module. If no backend name is given, it will default 
     15    to using MP3::Find::Filesystem. 
     16 
     17    Note: I'm still working out some kinks in the DB backend, so it is 
     18    currently not as stable as the Filesystem backend. 
     19 
     20    Note the second: This whole project is still in the alpha stage, so I 
     21    can make no guarentees that there won't be significant interface changes 
     22    in the next few versions or so. Also, comments about what about the API 
     23    rocks (or sucks!) are appreciated. 
    924 
    1025INSTALL 
     
    1732 
    1833SYNOPSIS 
    19         use MP3Find; 
     34        # select with backend you want 
     35        use MP3::Find qw(Filesystem); 
    2036     
    2137        print "$_\n" foreach find_mp3s( 
     
    2642            }, 
    2743            ignore_case => 1, 
    28             match_words => 1, 
     44            exact_match => 1, 
    2945            sort => [qw(year album tracknum)], 
    3046            printf => '%2n. %a - %t (%b: %y)', 
     
    3248 
    3349REQUIRES 
    34     File::Find, MP3::Info, Scalar::Util 
     50    File::Find, MP3::Info, and Scalar::Util are needed for the filesystem 
     51    backend (MP3::Find::Filesystem). In addition, if MP3::Tag is available, 
     52    you can search by explicit ID3v2 tag frames. 
    3553 
    36     DBI and DBD::SQLite are needed if you want to have a database backend. 
     54    DBI, DBD::SQLite, and SQL::Abstract are needed for the database backend 
     55    (MP3::Find::DB). 
    3756 
    3857COPYRIGHT AND LICENSE 
Note: See TracChangeset for help on using the changeset viewer.