branch: externals/substitute
commit b73b62df770ed6a685bbc83d64ce4da49d37f75d
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Add initial version of the README
---
README.md | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..0af9cfae6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Substitute (substitute.el)
+
+⚠️ WORK-IN-PROGRESS ⚠️
+
+Efficiently replace targets in the buffer or context.
+
+Sample configuration:
+
+```elisp
+(require 'substitute)
+
+;; If you like visual feedback on matching target. Default is nil.
+(setq substitute-highlight t)
+
+;; If you want a message reporting the matches that changed. We don't
+;; do it by default
+(add-hook 'substitute-post-replace-hook #'substitute-report-operation)
+
+;; We do not bind any keys. This is just an idea. The mnemonic is
+;; that M-# (or M-S-3) is close to M-% (or M-S-5).
+(let ((map global-map))
+ (define-key map (kbd "M-# s") #'substitute-target-below-point)
+ (define-key map (kbd "M-# r") #'substitute-target-above-point)
+ (define-key map (kbd "M-# d") #'substitute-target-in-function)
+ (define-key map (kbd "M-# M-#") #'substitute-target))
+```
+
++ Package name (GNU ELPA): `substitute` (not available yet)
++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/substitute>
+ - Mirrors:
+ + GitHub: <https://github.com/protesilaos/substitute>
+ + GitLab: <https://gitlab.com/protesilaos/substitute>
++ Mailing list: <https://lists.sr.ht/~protesilaos/general-issues>
++ Backronym: Some Utilities Built to Substitute Things Independent of
+ Their Utterances, Thoroughly and Easily.
