branch: externals/ivy-posframe
commit 8d0b0ae4cf75048d84b461426f8aeb08a7ebf173
Author: Feng Shu <[email protected]>
Commit: Feng Shu <[email protected]>
Update
---
ivy-posframe.el | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/ivy-posframe.el b/ivy-posframe.el
index d0c2f69..01574dc 100644
--- a/ivy-posframe.el
+++ b/ivy-posframe.el
@@ -26,8 +26,21 @@
;;; Commentary:
-
;; * ivy-posframe README :README:
+;; ** What is ivy-posframe
+;; ivy-posframe is a ivy extension, which let ivy use posframe
+;; to show its candidate menu.
+
+;; [[./snapshots/ivy-posframe1.gif]]
+
+;; [[./snapshots/ivy-posframe2.gif]]
+
+;; ** How to use ivy-posframe
+
+;; #+BEGIN_EXAMPLE
+;; (require 'ivy-posframe)
+;; (ivy-posframe-mode 1)
+;; #+END_EXAMPLE
;;; Code:
;; * ivy-posframe's code
