Readme

diff --git a/README.md b/README.md
index cfee03b12260665d84b9839b70a1ab63d6c565d6..fcedd50758005c0a66d2d23e127f04257751dac1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,36 @@
 aggressive-indent-mode
 ======================
 
-Emacs minor mode that keeps your code always indented. More reliable than electric-indent-mode.
+`electric-indent-mode` is enough to keep your code nicely aligned when
+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
+indented. It reindents after every command, making it more reliable
+than `electric-indent-mode`.
+
+### Instructions ###
+
+This package is available fom Melpa, you may install it by calling
+
+    M-x package-install RET aggressive-indent
+
+Then activate it with
+
+    (add-hook 'emacs-lisp-mode-hook #'aggressive-indent-mode)
+    (add-hook ’css-mode-hook #'aggressive-indent-mode)
+
+You can use this hook on any mode you want, `aggressive-indent` is not
+exclusive to emacs-lisp code. In fact, if you want to turn it on for
+every programming mode, you can do something like:
+
+    (global-aggressive-indent-mode 1)
+    (add-to-list 'aggressive-indent-excluded-modes 'html-mode)
+    
+### Manual Installation ###
+    
+If you don’t want to install from Melpa, you can download it manually,
+place it in your `load-path` and require it with
+
+    (require 'aggressive-indent)

diff --git a/aggressive-indent.el b/aggressive-indent.el
index 6a434dcb3187f8c1475885b878fcab00e8e3584b..5951976a4b7fc2d61ec7907a4bbaa17dfe1abd82 100644 (file)
--- a/aggressive-indent.el
+++ b/aggressive-indent.el
@@ -11,8 +11,40 @@
 ;; Separator: -
 
 ;;; Commentary:
-;;
-;;
+;; 
+;; `electric-indent-mode' is enough to keep your code nicely aligned when
+;; 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
+;; indented. It reindents after every command, making it more reliable
+;; than `electric-indent-mode'.
+;; 
+;; ### Instructions ###
+;; 
+;; This package is available fom Melpa, you may install it by calling
+;; 
+;;     M-x package-install RET aggressive-indent
+;; 
+;; Then activate it with
+;; 
+;;     (add-hook 'emacs-lisp-mode-hook #'aggressive-indent-mode)
+;;     (add-hook 'css-mode-hook #'aggressive-indent-mode)
+;; 
+;; You can use this hook on any mode you want, `aggressive-indent' is not
+;; exclusive to emacs-lisp code. In fact, if you want to turn it on for
+;; every programming mode, you can do something like:
+;; 
+;;     (global-aggressive-indent-mode 1)
+;;     (add-to-list 'aggressive-indent-excluded-modes 'html-mode)
+;;     
+;; ### Manual Installation ###
+;;     
+;; If you don't want to install from Melpa, you can download it manually,
+;; place it in your `load-path' and require it with
+;; 
+;;     (require 'aggressive-indent)
 
 ;;; Instructions:
 ;;