branch: externals/denote-journal
commit c42eb73d74449a5d6094aa585fa19519e3b5423b
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the README.md of denote-journal
---
README.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/README.md b/README.md
index adf57cfad4..875560c5da 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
# Denote Journal extras
WORK-IN-PROGRESS:
<https://protesilaos.com/codelog/2025-02-11-emacs-splitting-denote-many-packages/>.
+
+The `denote-journal` package makes it easier to use Denote for
+journaling. While it is possible to use the generic `denote` command
+(and related) to maintain a journal, this package defines extra
+functionality to streamline the journaling workflow.
+
+The code of `denote-journal` used to be bundled up with the `denote`
+package before version `4.0.0` of the latter and was available in the
+file `denote-journal-extras.el`. Users of the old code will need to
+adapt their setup to use the `denote-journal` package. This can be
+done by replacing all instances of `denote-journal-extras` with
+`denote-journal` across their configuration.
+
++ Package name (GNU ELPA): `denote-journal` (⚠️ Not available yet)
++ Official manual: <https://protesilaos.com/emacs/denote-journal>
++ Git repository: <https://github.com/protesilaos/denote-journal>
++ Backronym: Denote... Journaling Obviously Utilises Reasonableness
+ Notwithstanding Affectionate Longing.
