Changeset 19 in mp3-find for trunk/README

Timestamp:

03/28/06 19:38:39 (18 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:

• trunk/README (modified) (5 diffs)

trunk/README

@@ -1 @@
-MP3::Find version 0.01
+MP3::Find version 0.04
 ======================
+
 DESCRIPTION
     This module allows you to search for MP3 files by their ID3 tags. You
@@ -7 +8 @@
     formatted string for each file using its ID3 tags, or the actual Perl
     data structure representing the results.
+
+    There are currently two backends to this module: MP3::Find::Filesystem
+    and MP3::Find::DB. You choose which one you want by passing its name as
+    the argument to you "use" statement; MP3::Find will look for a
+    MP3::Find::$BACKEND module. If no backend name is given, it will default
+    to using MP3::Find::Filesystem.
+
+    Note: I'm still working out some kinks in the DB backend, so it is
+    currently not as stable as the Filesystem backend.
+
+    Note the second: This whole project is still in the alpha stage, so I
+    can make no guarentees that there won't be significant interface changes
+    in the next few versions or so. Also, comments about what about the API
+    rocks (or sucks!) are appreciated.
 
 INSTALL
@@ -17 +32 @@
 
 SYNOPSIS
-        use MP3Find;
+        # select with backend you want
+        use MP3::Find qw(Filesystem);
     
         print "$_\n" foreach find_mp3s(
@@ -26 +42 @@
             },
             ignore_case => 1,
-            match_words => 1,
+            exact_match => 1,
             sort => [qw(year album tracknum)],
             printf => '%2n. %a - %t (%b: %y)',
@@ -32 +48 @@
 
 REQUIRES
-    File::Find, MP3::Info, Scalar::Util
+    File::Find, MP3::Info, and Scalar::Util are needed for the filesystem
+    backend (MP3::Find::Filesystem). In addition, if MP3::Tag is available,
+    you can search by explicit ID3v2 tag frames.
 
-    DBI and DBD::SQLite are needed if you want to have a database backend.
+    DBI, DBD::SQLite, and SQL::Abstract are needed for the database backend
+    (MP3::Find::DB).
 
 COPYRIGHT AND LICENSE