From 16fbf1f17f09a8308d5e5df3a3a97277baa5736a Mon Sep 17 00:00:00 2001
From: Yuan Fu <casouri@gmail.com>
Date: Mon, 27 Feb 2023 18:36:24 -0800
Subject: [PATCH] ; * eldoc-box.el: Add a commentary section.

---
 eldoc-box.el | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/eldoc-box.el b/eldoc-box.el
index 5325c9a..e6af00a 100644
--- a/eldoc-box.el
+++ b/eldoc-box.el
@@ -32,10 +32,41 @@
 
 ;;; Commentary:
 ;;
-;; See documentation in README.org or visit homepage
+;; Usage:
+;;
+;; There are three ways to use this package:
+;;
+;; 1. Enable ‘eldoc-box-hover-mode’. Emacs will show the documentation
+;; of symbol at point in a children on the upper left or right corner.
+;;
+;; 2. Enable ‘eldoc-box-hover-at-point-mode’. Similar to
+;; ‘eldoc-box-hover-mode’, but displays the childframe at point. (This
+;; mode feels slower comparing to ‘eldoc-box-hover-mode’.)
+;;
+;; 3. Bind ‘eldoc-box-help-at-point’ to a key and bring up the
+;; documentation childframe on-demand. This command requires Emacs 28
+;; to work.
+;;
+;; Customization faces:
+;;
+;; - ‘eldoc-box-border’
+;; - ‘eldoc-box-body’
+;;
+;; Hooks:
+;;
+;; - ‘eldoc-box-buffer-hook’
+;; - ‘eldoc-box-frame-hook’
+;;
+;; Customize options:
+;;
+;; - ‘eldoc-box-max-pixel-width’
+;; - ‘eldoc-box-max-pixel-height’
+;; - ‘eldoc-box-only-multi-line’
+;; - ‘eldoc-box-cleanup-interval’
+;; - ‘eldoc-box-fringe-use-same-bg’
+;; - ‘eldoc-box-self-insert-command-list’
 
 ;;; Code:
-;;
 
 (require 'cl-lib)
 (require 'seq)