aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTslil Clingman <tslil.clingman@gmail.com>2018-07-05 21:32:37 +0200
committerTslil Clingman <tslil.clingman@gmail.com>2018-07-05 21:32:37 +0200
commitbb9f1fae670eff53f68c47f2f2fcdcad86e7fd01 (patch)
treea732d0907c2b8b8ec15a35f4afde01d7f00e04d9 /README.md
parent217b6ec5165e803131112c822a33bdf43c14a0de (diff)
Initial version
Updated README.org, included code.
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index d7c64ec..02803a7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
# siege-mode
-An emacs minor mode to surround the region with smart delimeters interactively
+An emacs minor mode to surround the region with smart delimiters
+interactively.
+
+## Lay siege to the region from all sides!
+### (with the power of regular expressions)
+
+When the region is active, all input is redirected to the minibuffer
+and treated as a delimeter for the region. By default the input is
+used as the left delimeter from which the right one is derived using
+`siege-left-to-right-regexs'. This may be reversed by default
+(`siege-default-left') or during usage via "C-c r" in the minibuffer.
+If regexes are not desired they may be disabled via "C-c a" in the
+minibuffer or by default (`siege-default-apply-regexs').
+
+All changes are dynamically displayed in the buffer (see
+`siege-preview-face') and may be committed by "SPC" or "Ret" in the
+minibuffer.
+
+The defaults support the obvious pairings, as well as `begin <--> end'
+and `left <--> right' of LaTeX fame.
+
+## Fancy GIF demo
+Accepting donations.
+