[elpa] externals/eldoc-eval 9ce3ca7d2c 12/28: * README.md: Update.

[Stefan Monnier via]

branch: externals/eldoc-eval
commit 9ce3ca7d2cf3bb51db72bff3487b258f681a8430
Author: Thierry Volpiatto <thierry.volpia...@gmail.com>
Commit: Thierry Volpiatto <thierry.volpia...@gmail.com>

    * README.md: Update.
---
 README.md | 36 ++++++++++++++++++++++--------------
 1 file changed, 22 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index d29090240a..e523626b9a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
+Eldoc-eval
+==========
+
+You can  [![Support via 
Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.3/dist/gratipay.png)](https://gratipay.com/thierryvolpiatto)
 or 
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=thierry.volpia...@gmail.com&lc=US&currency_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted)
 to help this project.
+
+## Description
 Enable eldoc support when minibuffer is in use.
 
 # Commentary:
@@ -16,15 +22,15 @@ It also provides a convenient macro to enable eldoc support
 in your own functions using minibuffer or in your defadvices,
 that is `with-eldoc-in-minibuffer`, e.g:
 
-```lisp
-(defadvice edebug-eval-expression (around with-eldoc activate)
-  "This advice enable eldoc support."
-  (interactive (list (with-eldoc-in-minibuffer
-                       (read-from-minibuffer
-                        "Eval: " nil read-expression-map t
-                        'read-expression-history))))
-  ad-do-it)
-```
+
+    defadvice edebug-eval-expression (around with-eldoc activate)
+     "This advice enable eldoc support."
+     (interactive (list (with-eldoc-in-minibuffer
+                          (read-from-minibuffer
+                           "Eval: " nil read-expression-map t
+                           'read-expression-history))))
+     ad-do-it)
+
 
 Users of own minibuffer frame will have to set
 `eldoc-in-minibuffer-own-frame-p` to non-nil.
@@ -34,9 +40,11 @@ with `eldoc-in-minibuffer-mode`.
 
 # Install:
 
-Add to .emacs:
+Add to your init file:
+
+If installed from git, add eldoc-eval.el to `load-path` and
+
+    (autoload 'eldoc-in-minibuffer-mode "eldoc-eval")
+    (eldoc-in-minibuffer-mode 1)
 
-```lisp
-   (autoload 'eldoc-in-minibuffer-mode "eldoc-eval")
-   (eldoc-in-minibuffer-mode 1)
-```
+Otherwise only `(eldoc-in-minibuffer-mode 1)` is needed.