[elpa] externals/consult-recoll 2bd1ed98b2 2/2: readme: tips for help integration

[ELPA Syncer]

branch: externals/consult-recoll
commit 2bd1ed98b23c2b72617fcef11aba7eb969b94ffa
Author: jao <jao@gnu.org>
Commit: jao <jao@gnu.org>

    readme: tips for help integration
---
 readme.org | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/readme.org b/readme.org
index dfdb88bbed..d6ce51f2cc 100644
--- a/readme.org
+++ b/readme.org
@@ -34,6 +34,16 @@ as [[http://elpa.gnu.org/packages/vertico.html][vertico]].
 This package is part of 
[[http://elpa.gnu.org/packages/consult-recoll.html][GNU ELPA]], so for recent 
Emacs versions you can install
 it directly via =M-x package-install RET consult-recoll RET=.
 
+*** Tip: using consult-recoll with helm
+    If you use =helm-mode=, you'll need to disable helm's completing read for
+    =consult-recoll=, with something like:
+    #+begin_src emacs-lisp
+      (with-eval-after-load "helm"
+        (with-eval-after-load "recoll"
+          (add-to-list 'helm-completing-read-handlers-alist
+                       (cons #'consult-recoll nil))))
+    #+end_src
+
 * Searching
 
     The entry point of ~consult-recoll~ is the interactive command
@@ -172,3 +182,4 @@ it directly via =M-x package-install RET consult-recoll 
RET=.
   - [[https://codeberg.org/rougier][Nicholas P. Rougier]] for useful 
discussions and suggestions,
     including actual fixes.
   - [[https://codeberg.org/monnier][Stefan Monnier]] for setting up the GNU 
ELPA package.
+  - Johan Widén for tips on using consult-recoll with helm.