branch: externals/pulsar
commit ad3c9df6aedfb163e29966dc785d35df83ba6821
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Update the README.md description of the package and the Commentary
---
README.md | 10 +++++-----
pulsar.el | 9 +++++----
2 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index f6d6862eb2..9a8aece835 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
# Pulsar
-This is a small Emacs package that temporarily highlights the current
-line after a given function is invoked. The affected functions are
-defined in the user option `pulsar-pulse-functions`. What Pulsar does
-is set up an advice so that those functions run a hook after they are
-called. The pulse effect is added there (`pulsar-after-function-hook`).
+This is a small Emacs package that automatically highlights the current
+line after certain functions are invoked. It can also highlight a line
+or region on demand. The idea is to make it easier to find where the
+point is, what was affected, and also to bring attention to something
+in a buffer.
+ Package name (GNU ELPA): `pulsar`
+ Official manual: <https://protesilaos.com/emacs/pulsar>
diff --git a/pulsar.el b/pulsar.el
index 50dd641fb0..f980bc818b 100644
--- a/pulsar.el
+++ b/pulsar.el
@@ -26,10 +26,11 @@
;;; Commentary:
;;
-;; This is a small package that temporarily highlights the current
-;; line after certain functions are called. It can also highlight a
-;; line or region on demand. Different types of highlighting are
-;; supported. Consult the official manual for the technicalities.
+;; This is a small Emacs package that automatically highlights the
+;; current line after certain functions are invoked. It can also
+;; highlight a line or region on demand. The idea is to make it
+;; easier to find where the point is, what was affected, and also to
+;; bring attention to something in a buffer.
;;
;; Why the name "pulsar"? It sounds like "pulse" and is a
;; recognisable word. Though if you need a backronym, consider
