Update VPIT::TestHelpers to 15e8aee3

[perl/modules/subs-auto.git] / README

diff --git a/README b/README
index 674535ce4fa6ddc4fa36a5de8d0e87b8250d4026..af1bd86b15c1294679e252bcfa607150c0b12f26 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     subs::auto - Read barewords as subroutine names.
 
 VERSION
-    Version 0.01
+    Version 0.08
 
 SYNOPSIS
         {
@@ -16,18 +16,32 @@ SYNOPSIS
          foo->meth;       # "'foo'->meth" if you have use'd foo somewhere,
                           #  or "foo()->meth" otherwise
          print foo 'wut'; # print to the filehandle foo if it's actually one,
-                          #  or "foo()->print('wut')" otherwise
+                          #  or "print(foo('wut'))" otherwise
         } # ... but function calls will fail at run-time if you don't
           # actually define foo somewhere
-    
+
         foo; # BANG
 
 DESCRIPTION
     This pragma lexically enables the parsing of any bareword as a
     subroutine name, except those which corresponds to an entry in %INC
-    (expected to be class names) or whose symbol table entry has a IO slot
+    (expected to be class names) or whose symbol table entry has an IO slot
     (expected to be filehandles).
 
+    You can pass options to "import" as key / value pairs :
+
+    *   "in => $pkg"
+
+        Specifies on which package the pragma should act. Setting $pkg to
+        "Some::Package" allows you to resolve all functions name of the type
+        "Some::Package::func ..." in the current scope. You can use the
+        pragma several times with different package names to allow
+        resolution of all the corresponding barewords.
+
+        Defaults to the current package.
+
+    This module is not a source filter.
+
 EXPORT
     None.
 
@@ -41,19 +55,29 @@ CAVEATS
     outside (or by actually defining "foo", which is ultimately why you use
     this pragma, right ?).
 
+    You have to open global filehandles outside of the scope of this pragma
+    if you want them not to be treated as function calls. Or just use
+    lexical filehandles and default ones as you should be.
+
+    This pragma doesn't propagate into "eval STRING".
+
 DEPENDENCIES
     perl 5.10.0.
 
-    Carp (standard since perl 5), Symbol (since 5.002).
+    A C compiler. This module may happen to build with a C++ compiler as
+    well, but don't rely on it, as no guarantee is made in this regard.
 
     Variable::Magic with "uvar" magic enabled (this should be assured by the
     required perl version).
 
+    B::Keywords.
+
+    Carp (standard since perl 5), XSLoader (since 5.6.0).
+
 AUTHOR
     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 
-    You can contact me by mail or on #perl @ FreeNode (vincent or
-    Prof_Vince).
+    You can contact me by mail or on "irc.perl.org" (vincent).
 
 BUGS
     Please report any bugs or feature requests to "bug-subs-auto at
@@ -74,7 +98,7 @@ ACKNOWLEDGEMENTS
     Thanks to Sebastien Aperghis-Tramoni for helping to name this pragma.
 
 COPYRIGHT & LICENSE
-    Copyright 2008 Vincent Pit, all rights reserved.
+    Copyright 2008,2009,2010,2011,2013 Vincent Pit, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.