]> code.delx.au - gnu-emacs-elpa/commitdiff
Move up the screencast
authorArtur Malabarba <bruce.connor.am@gmail.com>
Thu, 23 Oct 2014 09:19:58 +0000 (10:19 +0100)
committerArtur Malabarba <bruce.connor.am@gmail.com>
Thu, 23 Oct 2014 09:19:58 +0000 (10:19 +0100)
README.md

index a0f610c22dc0a622c0191c618cdca01a78da4356..f1a61a96ab54bb9a8d1aacf4fdf3a975d417ba8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,10 +6,14 @@ all you do is type. However, once you start shifting blocks around,
 transposing lines, or slurping and barfing sexps, indentation is bound
 to go wrong.
 
-`aggressive-indent-mode` is a minor mode that keeps your code always
+**`aggressive-indent-mode`** is a minor mode that keeps your code **always**
 indented. It reindents after every command, making it more reliable
 than `electric-indent-mode`.
 
+### Demonstration ###
+
+![aggressive-indent](aggressive-indent.gif)
+
 ### Instructions ###
 
 This package is available fom Melpa, you may install it by calling
@@ -28,10 +32,12 @@ every programming mode, you can do something like:
     (global-aggressive-indent-mode 1)
     (add-to-list 'aggressive-indent-excluded-modes 'html-mode)
 
-DEMO:
-
-![aggressive-indent](aggressive-indent.gif)
 
+*Plase Note:* `aggressive-indent` works superbly with lisp-like modes
+ (where `end-of-defun`) works very nicely. However, in some c-like
+ modes aggressive-indent
+ [might cause some lag](https://github.com/Bruce-Connor/aggressive-indent-mode/issues/7),
+ I'm working on that.
 
 ### Manual Installation ###