[elpa] externals/jinx 4498984860 1/2: Update readme

[ELPA Syncer]

branch: externals/jinx
commit 44989848609a23ae9ae05c588115705ecd154e77
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    Update readme
---
 README.org | 15 +++++++++------
 jinx.el    | 10 ++++++----
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/README.org b/README.org
index 289c35225e..7d6e12f487 100644
--- a/README.org
+++ b/README.org
@@ -16,9 +16,8 @@ Jinx is a fast just-in-time spell-checker for Emacs. Jinx 
highlights misspelled
 words in the text of the visible portion of the buffer. For efficiency, Jinx
 highlights misspellings lazily, recognizes window boundaries and text folding,
 if any. For example, when unfolding or scrolling, only the newly visible part 
of
-the text is checked, if it has not been checked before. Each misspelling can
-then be corrected from a list of dictionary words presented as completion
-candidates in a list.
+the text is checked if it has not been checked before. Each misspelling can be
+corrected from a list of dictionary words presented as a completion menu.
 
 Installing Jinx is straight-forward and configuring takes not much 
intervention.
 Jinx can safely co-exist with Emacs's built-in spell-checker.
@@ -68,9 +67,7 @@ command, =jinx-mode=, for activating for specific modes.
 Jinx autoloads the commands =jinx-correct= and =jinx-languages=. Invoking
 =jinx-correct= corrects the misspellings. Binding =jinx-correct= to =M-$= 
chord takes
 over that chord from Emacs's default assignment to =ispell word=. Since Jinx is
-independent of the Emacs's Ispell package, =M-$= can be re-used. The 
=use-package=
-definition above shows that. The same reassignment using regular keymap is 
shown
-below:
+independent of the Emacs's Ispell package, =M-$= can be re-used.
 
 #+begin_src emacs-lisp
   (keymap-global-set "<remap> <ispell-word>" #'jinx-correct)
@@ -79,6 +76,12 @@ below:
 - =M-$= triggers correction for the misspelled word next to point.
 - =C-u M-$= triggers correction for the entire buffer.
 
+Suggested corrections are displayed via a completion menu. You can press digit
+keys to quickly select a suggestion. Furthermore the menu offers options to 
save
+the word temporarily for the current session, in the personal dictionary or in
+the file-local variables. Note that you can enter arbitrary input at the
+correction prompt in order to make the correction.
+
 A sample configuration with the popular =use-package= macro is shown here:
 
 #+begin_src emacs-lisp
diff --git a/jinx.el b/jinx.el
index 98cc896b39..028c148be1 100644
--- a/jinx.el
+++ b/jinx.el
@@ -4,12 +4,14 @@
 
 ;; Author: Daniel Mendler <mail@daniel-mendler.de>
 ;; Maintainer: Daniel Mendler <mail@daniel-mendler.de>
-;; Package-Requires: ((emacs "27.1") (compat "29.1.4.0"))
 ;; Created: 2023
 ;; Version: 0.6
+;; Package-Requires: ((emacs "27.1") (compat "29.1.4.0"))
 ;; Homepage: https://github.com/minad/jinx
 ;; Keywords: convenience, wp
 
+;; This file is part of GNU Emacs.
+
 ;; This program is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
 ;; the Free Software Foundation, either version 3 of the License, or
@@ -30,9 +32,9 @@
 ;; the buffer.  For efficiency, Jinx highlights misspellings lazily,
 ;; recognizes window boundaries and text folding, if any.  For
 ;; example, when unfolding or scrolling, only the newly visible part
-;; of the text is checked, if it has not been checked before.  Each
-;; misspelling can then be corrected from a list of dictionary words
-;; presented as completion candidates in a list.
+;; of the text is checked if it has not been checked before.  Each
+;; misspelling can be corrected from a list of dictionary words
+;; presented as a completion menu.
 
 ;; Installing Jinx is straight-forward and configuring takes not much
 ;; intervention.  Jinx can safely co-exist with Emacs's built-in