From 445a56e2fb8aa167377f0c19e661b4e46f6d396d Mon Sep 17 00:00:00 2001 From: Yuan Fu Date: Tue, 11 Dec 2018 10:33:52 -0500 Subject: [PATCH] Update readme Suggest how to use with eglot. --- README.org | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.org b/README.org index 868a636..5d48ee6 100644 --- a/README.org +++ b/README.org @@ -12,3 +12,10 @@ Show the documentation of the symbol at point: =eldoc-box-help-at-point= Show documentation upon hover: =eldoc-box-hover-mode=. Note that you need to enable ElDoc mode for this to work. Adjust =:background= of =eldoc-box-border= face for border color. Adjust =:background= of =eldoc-box-body= face for background color of childframe. + +** Use with eglot +As of writing this README, eglot doesn't have a public mode hook, use this hook: + +#+BEGIN_SRC emacs-lisp +(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t) +#+END_SRC