Updating documentation after autosave patch

Changelog

@@ -1,3 +1,45 @@
+2025-03-05 cage
+
+        * README.org:
+
+        Merge pull request #165 from krvkir/master
+        - fixed typo in README.
+        - updated README.
+
+2025-03-02 krvkir
+
+        * annotate.el:
+
+        [fix] a typo in the doc, if -> when, improved formatting
+
+2025-02-21 krvkir
+
+        * annotate.el:
+
+        [fix] make autosave disabled by default
+
+2025-02-17 krvkir
+
+        * annotate.el:
+
+        [add] autosave option
+
+2024-10-17 cage2
+
+
+        Merge pull request #163 from cage2/master
+
+2024-10-16 cage
+
+        * Changelog,
+        * NEWS.org,
+        * annotate.el:
+
+        - added the chance to append a newline character at the end of a
+        buffer when it does not terminate with a proper line.
+        - updated news file.
+        - updated changelog.
+
 2024-10-16 cage
 
         * NEWS.org,
@@ -1294,6 +1336,7 @@
 	  available  overlay.   So  the annotated  text  contained  multiple
 	  overlays and an  annotation was not the first we  missed the last,
 	  This means, for example, that the annotation was not modifiable.
+
 2020-03-16 Bastian Bechtold, cage
         * annotate.el (annotate-create-annotation)
 

NEWS.org

@@ -1,3 +1,7 @@
+- 2025-03-05 v2.3.0 krvkir ::
+
+  This version adds a new customizable variable to instructs annotate.el to save annotation's database each time a new annotation is created, deleted or amended.
+
 - 2024-10-10 v2.2.3 cage ::
 
   This version contains code that asks the user to append a newline character to the end of a buffer if such buffer does not terminates with a newline character (if the newline is not present the annotated text is highlighted but the annotation text is not shown).

README.org

@@ -133,7 +133,7 @@ The annotation text can be pressed to and will open the annotated file, placing
 
 *** ~C-c C-c~ (function annotate-change-annotation-colors)
 
-Change the color of the annotation below point (both higlight and annotation text colors are changed).
+Change the color of the annotation below point (both highlight and annotation text colors are changed).
 
 These changes are kept after the buffer is killed.
 
@@ -159,7 +159,6 @@ Alternatively, they can be integrated ~annotate-integrate-annotations~ as commen
      - ~annotate-integrate-highlight~
      - ~annotate-fallback-comment~
 
-
 * Importing
 
 An annotation database file can be imported using the command ~annotate-import-annotations~.
@@ -217,6 +216,11 @@ Shows or hides annotation's text under cursor.
 ** annotate-toggle-all-annotations-text
 Shows or hides the annotation's text in the whole buffer.
 
+* Other customization variables
+
+**  annotate-autosave
+Whether annotations should be saved after each user action, e.g. new annotation created, existing one amended or deleted. Boolean value, default is ~nil~ i.e. do not perform autosave and update the annotations in a buffer, just after killing buffer or quitting Emacs.
+
 * More documentation
 
 Please check ~M-x customize-group RET annotate~ as there is extensive documentation for each customizable variable.

annotate.el

@@ -7,7 +7,7 @@
 ;; Maintainer: Bastian Bechtold <bastibe.dev@mailbox.org>, cage <cage-dev@twistfold.it>
 ;; URL: https://github.com/bastibe/annotate.el
 ;; Created: 2015-06-10
-;; Version: 2.2.3
+;; Version: 2.3.0
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -58,7 +58,7 @@
 ;;;###autoload
 (defgroup annotate nil
   "Annotate files without changing them."
-  :version "2.2.3"
+  :version "2.3.0"
   :group 'text)
 
 (defvar annotate-mode-map