diff --git a/README.md b/README.md index 86f95fb..2f9c481 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ -# jscode-find-callee +# jscode-find-callee [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/paulvollmer/jscode-find-callee/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/jscode-find-callee.svg?style=flat)](https://www.npmjs.com/package/jscode-find-callee) This is a tool to find calls at javascript code. +### Installation + +``` +npm install -g jscode-find-callee +``` + ### Usage The following example will search for all `console` calls at the `fixtures/console_log_2.js` sourcecode. ``` -node bin/jscode-find-callee fixtures/console_log_2.js +jscode-find-callee fixtures/console_log_2.js ``` If you want to search for an other callee instead of `console` you can use the `--name` flag. ``` -node bin/jscode-find-callee --name logger fixtures/console_log_2.js +jscode-find-callee --name logger fixtures/console_log_2.js ``` It is also possible to search an entire directory. ``` -node bin/jscode-find-callee --name console fixtures +jscode-find-callee --name console fixtures ```