Add readme

This commit is contained in:
Yuan Fu 2018-12-10 20:30:33 -05:00
parent bfda87893d
commit a5d2a7eccd
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901

10
README.org Normal file
View File

@ -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.