branch: externals/dired-preview
commit 364fab84a3f634106864b52fe54b55e819d4e024
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Update README.md to include package name and description
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index ea658ef287..a3de8fef9a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,13 @@
# dired-preview for Emacs
-+ Package name (GNU ELPA): `dired-preview` (⚠️ not available yet;
- public testing phase as of 2023-06-25)
+This is a simple and robust package to automatically preview in a side
+window the file at point in Dired buffers. Preview windows are closed
+when they are no longer relevant, while preview buffers are killed if
+they have not been used for other purposes beside previewing. The
+package provides several customisation options to control its
+behaviour.
+
++ Package name (GNU ELPA): `dired-preview`
+ Official manual: <https://protesilaos.com/emacs/dired-preview>
+ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/dired-preview>
- Mirrors:
