update library package usage comments

diff --git a/README.md b/README.md
index 2eb1327..8d5b7cb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # inline-docs.el
 
-Show inline contextual docs in Emacs.
+This is a library for showing inline contextual docs above or below.
 
 This source code mainly is
 from [justbur](https://emacs.stackexchange.com/users/14114/justbur)
@@ -13,6 +13,12 @@ answered
 
 # Usage
 
+You can use this library function `inline-docs` in packages like [eldoc-overlay-mode](https://github.com/stardiviner/eldoc-overlay-mode).
+
+```eldoc
+(setq eldoc-message-function #'inline-docs)
+```
+
 ```elisp
 (inline-docs "FORMATED-STRING")
 (inline-docs "STRING")

diff --git a/inline-docs.el b/inline-docs.el
index b4bc62e..259347f 100644 (file)
--- a/inline-docs.el
+++ b/inline-docs.el
@@ -9,7 +9,19 @@
 
 ;;; Commentary:
 
-
+;; This is a library for showing inline contextual docs above or below.
+;;
+;; You can use this library function `inline-docs` in packages like
+;; https://github.com/stardiviner/eldoc-overlay-mode.
+;;
+;; ```eldoc
+;; (setq eldoc-message-function #'inline-docs)
+;; ```
+;;
+;; ```elisp
+;; (inline-docs "FORMATED-STRING")
+;; (inline-docs "STRING")
+;; ```
 
 ;;; Code:
 ;;; ----------------------------------------------------------------------------