branch: elpa/engine-mode
commit 4fa7ee6c0605aec0ca485f381cb5e57d8cd72247
Author: Harry Schwartz <ha...@thoughtbot.com>
Commit: Harry Schwartz <ha...@thoughtbot.com>
Add documentation for changing the default browser
Technically this isn't part of engine-mode, but it's something that
users would conceivably want to know. Might as well explain it!
---
README.md | 19 ++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 020d3383d1..d4fb291c16 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ region is selected) and search GitHub for it, displaying the
results
in your default browser.
The `defengine` macro can also take an optional key combination,
-prefixed with `engine/keymap-prefix' (which defaults to "C-c /"):
+prefixed with `engine/keymap-prefix` (which defaults to "C-c /"):
```emacs
(defengine duckduckgo
@@ -40,6 +40,23 @@ load path and globally enabling it:
(engine-mode t)
```
+## Changing your default browser
+
+`engine-mode` uses `browse-url` to open the URL it constructs. To
+change the browser that `browse-url` uses, you'll need to redefine
+the `browse-url-browser-function` variable.
+
+For example, to use Emacs' built-in `eww` browser:
+
+```emacs
+(setq browse-url-browser-function 'eww-browse-url)
+```
+
+The implementation of the `browse-url-browser-function` variable
+contains a comprehensive list of possible browsing functions. You can
+get to that by hitting `C-h v browser-url-browser-function <RETURN>`
+and following the link to `browse-url.el`.
+
## Examples
```emacs
