branch: externals/denote-org
commit 967afc49f68a1ee58e3aec0542cf4f59dcc3aaac
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the package README.md to provide the essential information
---
README.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/README.md b/README.md
index c702beeb42..60f1c54504 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
# denote-org: Extras to integrate Org mode with Denote (like Org dynamic
blocks)
WORK-IN-PROGRESS:
<https://protesilaos.com/codelog/2025-02-11-emacs-splitting-denote-many-packages/>.
+
+The `denote-org` package contains extra features that better integrate
+Denote with Org mode. These used to be available as part of the main
+`denote` package in a file called `denote-org-extras.el`, but now live
+in this standalone package to main things easier to maintain and
+understand.
+
+With `denote-org`, users have Org-specific extensions such as dynamic
+blocks, links to headings, and splitting an Org subtree into its own
+standalone file. This package's official manual covers the
+technicalities.
+
++ Package name (GNU ELPA): `denote-org` (⚠️ Not available yet)
++ Official manual: <https://protesilaos.com/emacs/denote-org>
++ Git repository: <https://github.com/protesilaos/denote-org>
++ Backronym: Denote... Ordinarily Restricts Gyrations.
