add trailing_whitespace option and release (3 times)

[catagits/Test-EOL.git] / README

diff --git a/README b/README
index eff543d..d7ba2fe 100644 (file)
--- a/README
+++ b/README
@@ -2,11 +2,16 @@ NAME
     Test::EOL - Check the correct line endings in your project
 
 SYNOPSIS
-    "Test::EOL" lets you check the presence of tabs in your perl code. It
-    report its results in standard "Test::Simple" fashion:
+    "Test::EOL" lets you check the presence of windows line endings in your
+    perl code. It report its results in standard "Test::Simple" fashion:
 
       use Test::EOL tests => 1;
-      eol_unix_ok( 'lib/Module.pm', 'Module is tab free');
+      eol_unix_ok( 'lib/Module.pm', 'Module is ^M free');
+
+    and to add checks for trailing whitespace:
+
+      use Test::EOL tests => 1;
+      eol_unix_ok( 'lib/Module.pm', 'Module is ^M and trailing whitespace free', { trailing_whitespace => 1 });
 
     Module authors can include the following in a t/eol.t and have
     "Test::EOL" automatically find and check all perl files in a module
@@ -20,16 +25,26 @@ SYNOPSIS
       use Test::EOL;
       all_perl_files_ok( @mydirs );
 
+    and if authors would like to check for trailing whitespace:
+
+      use Test::EOL;
+      all_perl_files_ok({ trailing_whitespace => 1 });
+
+    or
+
+      use Test::EOL;
+      all_perl_files_ok({ trailing_whitespace => 1 }, @mydirs );
+
 DESCRIPTION
     This module scans your project/distribution for any perl files (scripts,
-    modules, etc) for the presence of tabs.
+    modules, etc) for the presence of windows line endings.
 
 EXPORT
     A list of functions that can be exported. You can delete this section if
     you don't export anything, such as for a purely object-oriented module.
 
 FUNCTIONS
-  all_perl_files_ok( [ @directories ] )
+  all_perl_files_ok( [ \%options ], [ @directories ] )
     Applies "eol_unix_ok()" to all perl files found in @directories (and sub
     directories). If no <@directories> is given, the starting point is one
     level above the current running script, that should cover all the files
@@ -43,7 +58,7 @@ FUNCTIONS
 
     the total number of files tested must be specified.
 
-  eol_unix_ok( $file [, $text] )
+  eol_unix_ok( $file [, $text] [, \%options ]  )
     Run a unix EOL check on $file. For a module, the path (lib/My/Module.pm)
     or the name (My::Module) can be both used.