[elpa] externals/posframe bfd2e55 23/40: Update README

[Feng Shu]

branch: externals/posframe
commit bfd2e55219e0911980f4ea97b5995ce8553dce60
Author: Feng Shu <address@hidden>
Commit: Feng Shu <address@hidden>

    Update README
---
 README.md | 70 +++++++++++++++++++++++++++++++--------------------------------
 1 file changed, 35 insertions(+), 35 deletions(-)

diff --git a/README.md b/README.md
index ec20e1f..f8bdadc 100644
--- a/README.md
+++ b/README.md
@@ -3,54 +3,54 @@ Note: this file is auto converted from posframe.el by 
[el2org](https://github.co
 
 # &#30446;&#24405;
 
-1.  [Posframe README](#org39f1199)
-    1.  [What is posframe](#org75ffb09)
-    2.  [Installation](#org24e4d5a)
-    3.  [Usage](#org13172eb)
-        1.  [Create a posframe](#org71b175a)
-        2.  [Hide a posframe](#orgd63c00f)
-        3.  [Hide all posframes](#orge4e5227)
-        4.  [Delete a posframe](#orga7363c0)
-        5.  [Delete all posframes](#org58e322a)
-        6.  [Customizing pointer control](#orge28a877)
-        7.  [Set fallback argument of posframe-show](#org4610750)
+1.  [Posframe README](#org39288b3)
+    1.  [What is posframe?](#orgd6e2b14)
+    2.  [Installation](#orgc1a54a8)
+    3.  [Usage](#org489af32)
+        1.  [Create a posframe](#orgaea7ff4)
+        2.  [Hide a posframe](#org418597e)
+        3.  [Hide all posframes](#org89f2772)
+        4.  [Delete a posframe](#org6455737)
+        5.  [Delete all posframes](#org085d523)
+        6.  [Customizing mouse pointer control](#org3efdec6)
+        7.  [Set fallback arguments of posframe-show](#org873b94e)
 
 
-<a id="org39f1199"></a>
+<a id="org39288b3"></a>
 
 # Posframe README
 
 
-<a id="org75ffb09"></a>
+<a id="orgd6e2b14"></a>
 
-## What is posframe
+## What is posframe?
 
-Posframe can pop a posframe at point, this **posframe** is a
-child-frame with its root window's buffer.
+Posframe can pop up a frame at point, this **posframe** is a
+child-frame connected to its root window's buffer.
 
 The main advantages are:
 
 1.  It is fast enough for daily usage :-)
-2.  It works well with CJK language.
+2.  It works well with CJK languages.
 
-NOTE: For MacOS users, posframe need Emacs (version >= 26.0.91)
+NOTE: For MacOS users, posframe needs Emacs version >= 26.0.91
 
 ![img](./snapshots/posframe-1.png)
 
 
-<a id="org24e4d5a"></a>
+<a id="orgc1a54a8"></a>
 
 ## Installation
 
     (require 'posframe)
 
 
-<a id="org13172eb"></a>
+<a id="org489af32"></a>
 
 ## Usage
 
 
-<a id="org71b175a"></a>
+<a id="orgaea7ff4"></a>
 
 ### Create a posframe
 
@@ -78,46 +78,46 @@ NOTE: For MacOS users, posframe need Emacs (version >= 
26.0.91)
         C-h f posframe-show
 
 
-<a id="orgd63c00f"></a>
+<a id="org418597e"></a>
 
 ### Hide a posframe
 
     (posframe-hide " *my-posframe-buffer*")
 
 
-<a id="orge4e5227"></a>
+<a id="org89f2772"></a>
 
 ### Hide all posframes
 
     M-x posframe-hide-all
 
 
-<a id="orga7363c0"></a>
+<a id="org6455737"></a>
 
 ### Delete a posframe
 
 1.  Delete posframe and its buffer
     
         (posframe-delete " *my-posframe-buffer*")
-2.  Only delete posframe's frame
+2.  Only delete the frame
     
         (posframe-delete-frame " *my-posframe-buffer*")
 
 
-<a id="org58e322a"></a>
+<a id="org085d523"></a>
 
 ### Delete all posframes
 
     M-x posframe-delete-all
 
-Note: this command will delete all posframe buffers,
-suggest not run this command if you are sharing a buffer
+Note: this command will delete all posframe buffers.
+You probably shouldn't use it if you are sharing a buffer
 between posframe and other packages.
 
 
-<a id="orge28a877"></a>
+<a id="org3efdec6"></a>
 
-### Customizing pointer control
+### Customizing mouse pointer control
 
 By default, posframe moves the pointer to point (0,0) in
 the frame, as a way to address an issue with mouse focus.
@@ -126,16 +126,16 @@ To disable this feature, add this to your init.el:
     (setq posframe-mouse-banish nil)
 
 
-<a id="org4610750"></a>
+<a id="org873b94e"></a>
 
-### Set fallback argument of posframe-show
+### Set fallback arguments of posframe-show
 
-user can set fallback values of posframe-show's arguments with the
-help of \`posframe-arghandler'. the below example set fallback
+Users can set fallback values of posframe-show's arguments with the
+help of \`posframe-arghandler'.  The example below sets fallback
 border-width to 10 and fallback background color to green.
 
     (setq posframe-arghandler #'my-posframe-arghandler)
-    (defun my-posframe-arghandler (posframe-buffer arg-name value)
+    (defun my-posframe-arghandler (buffer-or-name arg-name value)
       (let ((info '(:internal-border-width 10 :background-color "green")))
         (or (plist-get info arg-name) value)))