From a5d2a7eccd3dedc76976ea7aef893a7df17d2f2a Mon Sep 17 00:00:00 2001 From: Yuan Fu Date: Mon, 10 Dec 2018 20:30:33 -0500 Subject: [PATCH] Add readme --- README.org | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.org diff --git a/README.org b/README.org new file mode 100644 index 0000000..36f7162 --- /dev/null +++ b/README.org @@ -0,0 +1,10 @@ +* Install +Get the file, add to load path, and +#+BEGIN_SRC emacs-lisp +(require 'eglot-doc) +#+END_SRC + +* Usage +Show the documentation of the symbol at point: =eglot-doc-help-at-point= + +Show documentation upon hover: =eglot-doc-hover-mode=. Note that you need to enable ElDoc mode for this to work.