Permalink
Browse files

docs

  • Loading branch information...
1 parent 63baa69 commit 730e7a6860ec9d43864abd33e8df1d93fa0866c7 @tj committed Aug 24, 2011
Showing with 25 additions and 1 deletion.
  1. +25 −1 Readme.md
View
@@ -9,7 +9,7 @@
## Usage
-```
+```bash
Usage: search [options] <query> [path ...]
@@ -21,6 +21,30 @@ Options:
```
+## Examples
+
+ The given `<query>` is a case-insensitive regular express,
+ so the query may express simple words or phrases, as well
+ as ones like `foo(bar)?`.
+
+```bash
+
+ $ search jade express/lib
+
+ express/lib/view.js
+ 100: // Try _ prefix ex: ./views/_<name>.jade
+ 107: // Try index ex: ./views/user/index.jade
+ 110: // Try ../<name>/index ex: ../user/index.jade
+ 114: // Try root ex: <root>/user.jade
+ 117: // Try root _ prefix ex: <root>/_user.jade
+
+ express/lib/view/view.js
+ 185: * files to jade:
+ 187: * app.register('.html', require('jade'));
+ 191: * app.register('html', require('jade'));
+
+```
+
## License
(The MIT License)

0 comments on commit 730e7a6

Please sign in to comment.