[elpa] externals/vertico 953ff1e 10/11: README: Document keymap

[Protesilaos Stavrou]

branch: externals/vertico
commit 953ff1ed6f592ac635fc317bead4c428f78f8ca6
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    README: Document keymap
---
 README.org | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index fbab1ad..f19160c 100644
--- a/README.org
+++ b/README.org
@@ -21,14 +21,32 @@ externally by complementary packages.
 - Non-existing candidates are entered by moving the point to the prompt line
 - Candidates are sorted by history, string length and alphabetically
 - Long candidates with newlines are formatted to take up less space
-- Support for =annotation-function=, =affixation-function= and 
=x-group-function=
+- Support for ~annotation-function~, ~affixation-function~ and 
~x-group-function~
+
+* Keymap
+
+Vertico defines its own local keymap in the minibuffer which is derived from
+~minibuffer-local-map~. The keymap mostly keeps the ~fundamental-mode~
+keybindings intact, but rebinds a few commands. Note in particular the binding
+of =TAB= to ~vertico-insert~ and the bindings of ~vertico-exit/exit-input~.
+
+- ~beginning-of-buffer~, ~minibuffer-beginning-of-buffer~ -> 
~vertico-beginning-of-buffer~
+- ~end-of-buffer~ -> ~vertico-end-of-buffer~
+- ~scroll-down-command~ -> ~vertico-scroll-down~
+- ~scroll-up-command~ -> ~vertico-scroll-up~
+- ~next-line~, ~next-line-or-history-element~ -> ~vertico-next~
+- ~previous-line~, ~previous-line-or-history-element~ -> ~vertico-previous~
+- ~exit-minibuffer~ -> ~vertico-exit~
+- ~kill-ring-save~ -> ~vertico-save~
+- =<C-return>= -> ~vertico-exit-input~
+- =TAB= -> ~vertico-insert~
 
 * Configuration
 
 Vertico is available from [[http://elpa.gnu.org/packages/vertico.html][GNU 
ELPA]], such that it can be installed directly via
-=package-install=. After installation, the global minor mode can be enabled 
with
+~package-install~. After installation, the global minor mode can be enabled 
with
 =M-x vertico-mode=. In order to configure Vertico and other packages in your
-init.el, you may want to use =use-package=. Here is an example configuration:
+init.el, you may want to use ~use-package~. Here is an example configuration:
 
 #+begin_src emacs-lisp
   ;; Enable vertico
@@ -81,7 +99,7 @@ disadvantages. The 
[[https://github.com/raxod502/selectrum][Selectrum readme]] p
 available completion systems from the perspective of Selectrum.
 
 Vertico aims to be fully compliant with all Emacs commands and achieves that
-with a minimal code base, relying purely on =completing-read= while avoiding to
+with a minimal code base, relying purely on ~completing-read~ while avoiding to
 invent its own APIs. Inventing a custom API as Helm or Ivy is explicitly 
avoided
 in order to increase flexibility and package reuse.