[Pkg-javascript-commits] [node-detective] 24/119: document opts.word

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-detective.

commit b8d654a10cb2507d2a468b449e5fba1b46cdf9f0
Author: James Halliday <mail at substack.net>
Date:   Fri Nov 25 18:54:58 2011 -0800

    document opts.word
---
 README.markdown | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/README.markdown b/README.markdown
index b1a3e9d..90ffa1a 100644
--- a/README.markdown
+++ b/README.markdown
@@ -39,20 +39,25 @@ methods
 
 var detective = require('detective');
 
-detective(src)
---------------
+detective(src, opts)
+--------------------
 
 Give some source body `src`, return an array of all the require()s with string
 arguments.
 
-detective.find(src)
--------------------
+The options parameter `opts` is passed along to `detective.find()`.
+
+detective.find(src, opts)
+-------------------------
 
 Give some source body `src`, return an object with "strings" and "expressions"
 arrays for each of the require() calls.
 
 The "expressions" array will contain the stringified expressions.
 
+Optionally you can specify a different function besides `"require"` to analyze
+with `opts.word`.
+
 installation
 ============
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-detective.git