branch: elpa/eldoc-mouse
commit 697dd42377cdeee4e4f0b8a12c61df2f90926666
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Update README.md
---
README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 73 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 7c250020a77..afe72e088e6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,74 @@
# eldoc-mouse
-Show document for mouse hover utilizing eldoc, eglot and eldoc-box
+
+`eldoc-mouse` is an Emacs package that enhances the `eldoc` functionality by
displaying documentation in a child frame when the mouse hovers over a symbol
in an `eglot`-managed buffer. It integrates with `eldoc-box` to provide popup
documentation and features a debounced hover mechanism to prevent excessive
requests to the LSP server.
+
+## Features
+- Displays documentation in a child frame when hovering over symbols in
`eglot`-managed buffers.
+- Integrates with `eldoc-box` for popup documentation.
+- Avoids spamming the LSP server by debouncing hover events.
+- Works in `prog-mode` buffers to show documentation for the symbol under the
mouse cursor.
+
+## Installation
+
+To install `eldoc-mouse`, you need to have `eldoc-box` and `eglot` installed.
You can install the package from MELPA:
+
+1. Add MELPA to your package archives if you haven't already:
+ ```elisp
+ (require 'package)
+ (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/";)
t)
+ (package-initialize)
+ ```
+
+2. Install `eldoc-mouse` from MELPA:
+ ```elisp
+ M-x package-install RET eldoc-mouse RET
+ ```
+
+Alternatively, if you want to install the package manually, you can clone this
repository and load it into your Emacs configuration:
+
+```sh
+git clone https://github.com/huangfeiyu/eldoc-mouse.git
+```
+Then, in your Emacs configuration:
+
+``` elisp
+(add-to-list 'load-path "/path/to/eldoc-mouse/")
+(require 'eldoc-mouse)
+```
+
+## Usage
+### Enable eldoc-mouse:
+Enabled by default, alternatively, run the command:
+```
+M-X: eldoc-mouse-enable
+```
+### Disable eldoc-mouse:
+If you want to disable eldoc-mouse, you can do so with:
+```
+M-X: eldoc-mouse-disable
+```
+## Customization
+
+You can customize the behavior of eldoc-mouse by adjusting the variables or
adding additional hooks. For instance, you can adjust the delay time between
mouse hover and displaying the documentation by changing the
eldoc-mouse-mouse-timer settings.
+## Requirements
+
+ Emacs 30.1 or higher
+ eldoc-box version 2.1.1 or higher
+ eglot version 1.8 or higher
+
+## License
+
+This package is licensed under the GNU General Public License v3
(GPL-3.0-or-later). See the LICENSE file for details.
+Contributing
+
+## Contribution
+Feel free to open issues and pull requests for improvements. If you encounter
any bugs or have feature requests, please create an issue on the GitHub Issues
page.
+Acknowledgments
+
+ eldoc-box: for providing popup documentation frames.
+ eglot: for offering Language Server Protocol (LSP) support in Emacs.
+ Emacs: for being an amazing, extensible text editor.
+
+Author
+
+Huang Feiyu [email protected]
