added keymaps; more detailed readme; documented configuration options

Author: leonid-shevtsov

Default (OSX).sublime-keymap

@@ -0,0 +1,3 @@
+[
+    { "keys": ["alt+super+shift+f"], "command": "search_in_project" }
+]

Default (Windows).sublime-keymap

@@ -0,0 +1,3 @@
+[
+    { "keys": ["alt+ctrl+shift+f"], "command": "search_in_project" }
+]

README.md

@@ -4,7 +4,7 @@ A plugin for [Sublime Text 2](http://www.sublimetext.com/).
 
 ## Synopsis
 
-This plugin makes it possible to use various external search tools (`grep`, `ack`, `ag`, `git grep`, or `findstr`) to find strings inside your current Sublime Text project.
+This plugin makes it possible to use various external search tools (`grep`, `ack`, `ag`, `git grep`, or `findstr`) to find strings aross your entire current Sublime Text project.
 
 It opens a quick selection panel to browse results, and highlights matches inside files.
 
@@ -16,14 +16,17 @@ Copy the folder into the Packages folder.
 
 ## Usage
 
-Call the "Search in Project" command.
+* Use the key binding (`⌘⌥^F` on OS X, `Ctrl+Alt+Shift+F` on Windows), or
+* Call the "Search in Project" command;
+* Enter the search query; **the query is passed directly to the shell command.** You are responsible for escaping the query, but on the up side you can specify any command line options to go with it. This plugin doesn't make an effort to abstract you away from search tools, but provides a convenient way of running them from Sublime Text 2 instead.
+* Hit `Enter` (`Return`). In a short while you'll be presented with a "quck select" panel with the search results. Select any file from that panel (it supports fuzzy searching) to go to the match.
 
 ## Configuration
 
 Configuration is stored in a separate, user-specific `SearchInProject.sublime-settings` file. See the default file for configuration options; links to both could be
 found in the main menu in `Preferences -> Package Settings -> Search In Project`.
 
-On any OS I recommend you to install [ack](http://betterthangrep.com/), and use it instead of the default `grep`/`findstr`, because it's much faster.
+On any OS I recommend you to install [ack](http://betterthangrep.com/), and use it instead of the default `grep`/`findstr`, because it's much faster. [Here's how to install ack on Windows](http://stackoverflow.com/questions/1023710/how-can-i-install-and-use-ack-library-on-windows).
 
 * * *
 

SearchInProject.sublime-settings

@@ -9,8 +9,12 @@
   "search_in_project_engine": "grep",
 
   /* Grep configuration */
+  /* Path to grep executable; if the standard one doesn't work for you, you can specify an explicit path in your user config file. */
   "search_in_project_Grep_path_to_executable": "grep",
+  /* Do NOT change these options; they are expected to be present for SearchInProject to work correctly. */
   "search_in_project_Grep_mandatory_options": "-nr",
+  /* Specify additional options to be used with all searches here. */
+  "search_in_project_Grep_common_options": "",
 
   /* Ack configuration */
   "search_in_project_Ack_path_to_executable": "ack",