branch: externals/urgrep
commit b578b0f857e31cdafb845687bf40d93d8ab81927
Author: Jim Porter <jporterb...@gmail.com>
Commit: Jim Porter <jporterb...@gmail.com>
Add a README and more-detailed docstrings
---
README.md | 15 +++++++++++++++
urgrep.el | 11 ++++++++---
2 files changed, 23 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..abb2c401f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Urgrep - Universal Recursive Grep
+
+Urgrep is an experimental Emacs package to provide an alternative to `M-x
rgrep`
+(and similar packages) which will eventually support for *any* grep-like tool.
+Currently, `ag`, `git grep`, and `grep`/`find` are supported.
+
+## Using Urgrep
+
+Load the package and type `C-h f urgrep RET`. That should show you the basics
+while the interface stabilizes (at which point it will be documented here).
+
+## Contributing
+
+It's a bit early for other contributors, but thanks for the thought! (Hopefully
+this will change after not too long.)
diff --git a/urgrep.el b/urgrep.el
index 7ae7ba242f..df1ae7eef5 100644
--- a/urgrep.el
+++ b/urgrep.el
@@ -381,10 +381,15 @@ This depends on the current values of various urgrep
options."
;;;###autoload
(cl-defun urgrep (query &optional directory &aux
(urgrep-search-regexp urgrep-search-regexp))
- "Search in DIRECTORY for a given QUERY.
+ "Recursively search in DIRECTORY for a given QUERY.
+
+When called interactively, search in the project's root directory, or
+the current directory if there is no current project. With
\\[universal-argument] prefix,
+search in the current directory. With two \\[universal-argument] prefixes,
prompt for a
+directory to search in.
\\<urgrep-minibuffer-map>
-The following keys are bound in `urgrep-minibuffer-map', active when entering
-the search query:
+The following keys are bound in `urgrep-minibuffer-map', active
+when entering the search query:
Type \\[urgrep-toggle-regexp] to toggle regular-expression mode."
(interactive
