[nongnu] elpa/idle-highlight-mode 59f5c6ce37 23/59: Add readme

[ELPA Syncer]

branch: elpa/idle-highlight-mode
commit 59f5c6ce377dfe825c5f72786eb9af97d7f797a6
Author: Campbell Barton <ideasman42@gmail.com>
Commit: Campbell Barton <ideasman42@gmail.com>

    Add readme
---
 readme.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000000..6a25ef64c4
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,28 @@
+####################
+Idle  Highlight Mode
+####################
+
+Simple highlighting package for Emacs.
+
+Usage
+=====
+
+Customization
+-------------
+
+``idle-highlight``
+   Face used for highlighting the symbol.
+``idle-highlight-exceptions``
+   Words to exclude from highlighting.
+``idle-highlight-idle-time``
+   Delay before highlighting (in seconds).
+
+Installation
+============
+
+.. code-block:: elisp
+
+   (use-package idle-highlight-mode
+     :config (setq idle-highlight-idle-time 0.2)
+
+     :hook ((prog-mode text-mode) . idle-highlight-mode)))